Add option to use all states of an input entity (pnbruckner#28)

Author: pnbruckner

.gitignore

@@ -3,3 +3,4 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+.vscode/

README.md

@@ -15,6 +15,7 @@ device_tracker:
     entity_id:
       - device_tracker.platform1_me
       - device_tracker.platform2_me
+      - binary_sensor.i_am_home
 ```
 
 ## Installation
@@ -58,7 +59,7 @@ sudo apt install libatlas3-base
 
 ### `device_tracker` platform
 
-- **entity_id**: Entity IDs of watched device tracker devices. Can be a single entity ID, a list of entity IDs, or a string containing multiple entity IDs separated by commas.
+- **entity_id**: Entity IDs of watched device tracker devices. Can be a single entity ID, a list of entity IDs, or a string containing multiple entity IDs separated by commas. Another option is to specify a dictionary with `entity` specifying the entity ID, and `all_states` specifying a boolean value that controls whether or not to use all states of the entity (rather than just the "Home" state, which is the default.)
 - **name**: Object ID (i.e., part of entity ID after the dot) of composite device. For example, `NAME` would result in an entity ID of `device_tracker.NAME`.
 - **require_movement** (*Optional*): `true` or `false`. Default is `false`. If `true`, will skip update from a GPS-based tracker if it has not moved. Specifically, if circle defined by new GPS coordinates and accuracy overlaps circle defined by previous GPS coordinates and accuracy then update will be ignored.
 - **time_as** (*Optional*): One of `utc`, `local`, `device_or_utc` or `device_or_local`. Default is `utc` which shows time attributes in UTC. `local` shows time attributes per HA's `time_zone` configuration. `device_or_utc` and `device_or_local` attempt to determine the time zone in which the device is located based on its GPS coordinates. The name of the time zone (or `unknown`) will be shown in a new attribute named `time_zone`. If the time zone can be determined, then time attributes will be shown in that time zone. If the time zone cannot be determined, then time attributes will be shown in UTC if `device_or_utc` is selected, or in HA's local time zone if `device_or_local` is selected.
@@ -67,7 +68,7 @@ sudo apt install libatlas3-base
 
 Watched GPS-based devices must have, at a minimum, the following attributes: `latitude`, `longitude` and `gps_accuracy`. If they don't they will not be used.
 
-For watched non-GPS-based devices, which states are used and whether any GPS data (if present) is used depends on several factors. E.g., if GPS-based devices are in use then the 'not_home'/'off' state of non-GPS-based devices will be ignored. If only non-GPS-based devices are in use, then the composite device will be 'home' if any of the watched devices are 'home'/'on', and will be 'not_home' only when _all_ the watched devices are 'not_home'/'off'.
+For watched non-GPS-based devices, which states are used and whether any GPS data (if present) is used depends on several factors. E.g., if GPS-based devices are in use then the 'not_home'/'off' state of non-GPS-based devices will be ignored (unless `all_states` was specified as `true` for that entity.) If only non-GPS-based devices are in use, then the composite device will be 'home' if any of the watched devices are 'home'/'on', and will be 'not_home' only when _all_ the watched devices are 'not_home'/'off'.
 
 If a watched device has a `last_seen` attribute, that will be used in the composite device. If not, then `last_updated` from the entity's state will be used instead.
 
@@ -108,6 +109,9 @@ device_tracker:
     entity_id:
       - device_tracker.platform1_me
       - device_tracker.platform2_me
+      - device_tracker.router_my_device
+      - entity: binary_sensor.i_am_home
+        all_states: true
 ```
 
 ### Time zone examples

custom_components/composite/const.py

@@ -1,6 +1,8 @@
 """Constants for Composite Integration."""
 DOMAIN = "composite"
 
+CONF_ALL_STATES = "all_states"
+CONF_ENTITY = "entity"
 CONF_REQ_MOVEMENT = "require_movement"
 CONF_TIME_AS = "time_as"
 

custom_components/composite/device_tracker.py

@@ -9,6 +9,7 @@
 from homeassistant.components.device_tracker import (
     ATTR_BATTERY,
     ATTR_SOURCE_TYPE,
+    DOMAIN as DT_DOMAIN,
     PLATFORM_SCHEMA,
     SOURCE_TYPE_BLUETOOTH,
     SOURCE_TYPE_BLUETOOTH_LE,
@@ -26,7 +27,6 @@
     ATTR_LONGITUDE,
     CONF_ENTITY_ID,
     CONF_NAME,
-    EVENT_HOMEASSISTANT_START,
     STATE_HOME,
     STATE_NOT_HOME,
     STATE_ON,
@@ -40,14 +40,15 @@
 from homeassistant.util.location import distance
 
 from .const import (
+    CONF_ALL_STATES,
+    CONF_ENTITY,
     CONF_REQ_MOVEMENT,
     CONF_TIME_AS,
     DOMAIN,
     TIME_AS_OPTS,
     TZ_DEVICE_LOCAL,
     TZ_DEVICE_UTC,
     TZ_LOCAL,
-    TZ_UTC,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -60,6 +61,7 @@
 INACTIVE = "inactive"
 ACTIVE = "active"
 WARNED = "warned"
+USE_ALL_STATES = "use_all_states"
 STATUS = "status"
 SEEN = "seen"
 SOURCE_TYPE = ATTR_SOURCE_TYPE
@@ -75,10 +77,40 @@
     SOURCE_TYPE_ROUTER,
 )
 
+
+def _entities(entities):
+    result = []
+    for entity in entities:
+        if isinstance(entity, dict):
+            result.append(entity)
+        else:
+            result.append(
+                {
+                    CONF_ENTITY: entity,
+                    CONF_ALL_STATES: False,
+                }
+            )
+    return result
+
+
+ENTITIES = vol.All(
+    cv.ensure_list,
+    [
+        vol.Any(
+            {
+                vol.Required(CONF_ENTITY): cv.entity_id,
+                vol.Required(CONF_ALL_STATES): cv.boolean,
+            },
+            cv.entity_id,
+            msg="Expected an entity ID",
+        )
+    ],
+    _entities,
+)
 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_NAME): cv.slugify,
-        vol.Required(CONF_ENTITY_ID): cv.entity_ids,
+        vol.Required(CONF_ENTITY_ID): ENTITIES,
         vol.Optional(CONF_TIME_AS, default=TIME_AS_OPTS[0]): vol.In(TIME_AS_OPTS),
         vol.Optional(CONF_REQ_MOVEMENT, default=False): cv.boolean,
     }
@@ -107,25 +139,29 @@ def __init__(self, hass, config, see):
         self._see = see
         entities = config[CONF_ENTITY_ID]
         self._entities = {}
-        for entity_id in entities:
+        entity_ids = []
+        for entity in entities:
+            entity_id = entity[CONF_ENTITY]
             self._entities[entity_id] = {
+                USE_ALL_STATES: entity[CONF_ALL_STATES],
                 STATUS: INACTIVE,
                 SEEN: None,
                 SOURCE_TYPE: None,
                 DATA: None,
             }
+            entity_ids.append(entity_id)
         self._dev_id = config[CONF_NAME]
-        self._entity_id = f"device_tracker.{self._dev_id}"
+        self._entity_id = f"{DT_DOMAIN}.{self._dev_id}"
         self._time_as = config[CONF_TIME_AS]
         if self._time_as in [TZ_DEVICE_UTC, TZ_DEVICE_LOCAL]:
             self._tf = hass.data[DOMAIN]
         self._req_movement = config[CONF_REQ_MOVEMENT]
         self._lock = threading.Lock()
         self._prev_seen = None
 
-        self._remove = track_state_change(hass, entities, self._update_info)
+        self._remove = track_state_change(hass, entity_ids, self._update_info)
 
-        for entity_id in entities:
+        for entity_id in entity_ids:
             self._update_info(entity_id, None, hass.states.get(entity_id))
 
     def _bad_entity(self, entity_id, message):
@@ -153,8 +189,8 @@ def _good_entity(self, entity_id, seen, source_type, data):
             {STATUS: ACTIVE, SEEN: seen, SOURCE_TYPE: source_type, DATA: data}
         )
 
-    def _use_non_gps_data(self, state):
-        if state == STATE_HOME:
+    def _use_non_gps_data(self, entity_id, state):
+        if state == STATE_HOME or self._entities[entity_id][USE_ALL_STATES]:
             return True
         entities = self._entities.values()
         if any(entity[SOURCE_TYPE] == SOURCE_TYPE_GPS for entity in entities):
@@ -262,7 +298,7 @@ def _update_info(self, entity_id, old_state, new_state):
 
                 self._good_entity(entity_id, last_seen, source_type, state)
 
-                if not self._use_non_gps_data(state):
+                if not self._use_non_gps_data(entity_id, state):
                     return
 
                 # Don't use new GPS data if it's not complete.