Merge pull request #14 from andrew-codechimp/friendly-names

Friendly names

Author: andrew-codechimp

README.md

@@ -10,7 +10,8 @@ Label State Helpers for Home Assistant
 
 You can create state, not state and numeric state helpers which provide a binary sensor that turns on if any entity with an assigned label matches the criteria you specify.
 
-An `entities` attribute is available which lists all entities that match the criteria.
+An `entities` attribute is available which lists all entities that match the criteria.  
+An `entity_names` attribute is available which lists either the device (entity) names or just the entity name if the entity is not part of a device, for all entities that match the criteria.
 
 ## Example use cases
 
@@ -82,7 +83,7 @@ actions:
     data:
       message: >-
         Critical sensors are unavailable {{
-        state_attr('binary_sensor.critical_sensor_unavailable', 'entities') |
+        state_attr('binary_sensor.critical_sensor_unavailable', 'entity_names') |
         join(', ') }}
 mode: single
 ```

custom_components/label_state/binary_sensor.py

@@ -11,6 +11,7 @@
     STATE_UNKNOWN,
 )
 from homeassistant.core import Event, EventStateChangedData, HomeAssistant, callback
+from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers import entity_registry as er
 from homeassistant.helpers.entity_platform import (
     AddConfigEntryEntitiesCallback,
@@ -22,6 +23,7 @@
 
 from .const import (
     ATTR_ENTITIES,
+    ATTR_ENTITY_NAMES,
     CONF_LABEL,
     CONF_STATE_LOWER_LIMIT,
     CONF_STATE_NOT,
@@ -264,6 +266,7 @@ def _calc_state(self) -> None:
 
         state_is_on: bool | None = False
         entities_on: list[str] = []
+        entity_names: list[str] = []
 
         entity_registry = er.async_get(self.hass)
 
@@ -281,6 +284,8 @@ def _calc_state(self) -> None:
                     ):
                         state_is_on = True
                         entities_on.append(entity_id)
+                        name = self._get_device_or_entity_name(entity_id)
+                        entity_names.append(name)
 
         if self._state_type == StateTypes.NOT_STATE:
             for entity_id in self._state_dict.keys():
@@ -296,6 +301,8 @@ def _calc_state(self) -> None:
                     ):
                         state_is_on = True
                         entities_on.append(entity_id)
+                        name = self._get_device_or_entity_name(entity_id)
+                        entity_names.append(name)
 
         if self._state_type == StateTypes.NUMERIC_STATE:
             for entity_id in self._state_dict.keys():
@@ -320,6 +327,9 @@ def _calc_state(self) -> None:
                                 ):
                                     state_is_on = True
                                     entities_on.append(entity_id)
+                                    name = self._get_device_or_entity_name(entity_id)
+                                    entity_names.append(name)
+
                                     LOGGER.debug(
                                         "State %s is below lower limit %s and above upper limit %s for %s",
                                         entity_state,
@@ -334,6 +344,9 @@ def _calc_state(self) -> None:
                                 ):
                                     state_is_on = True
                                     entities_on.append(entity_id)
+                                    name = self._get_device_or_entity_name(entity_id)
+                                    entity_names.append(name)
+
                                     LOGGER.debug(
                                         "State %s is below lower limit %s for %s",
                                         entity_state,
@@ -347,6 +360,9 @@ def _calc_state(self) -> None:
                                 ):
                                     state_is_on = True
                                     entities_on.append(entity_id)
+                                    name = self._get_device_or_entity_name(entity_id)
+                                    entity_names.append(name)
+
                                     LOGGER.debug(
                                         "State %s is above upper limit %s for %s",
                                         entity_state,
@@ -368,3 +384,20 @@ def _calc_state(self) -> None:
 
         self._attr_is_on = state_is_on
         self._attr_extra_state_attributes[ATTR_ENTITIES] = entities_on
+        self._attr_extra_state_attributes[ATTR_ENTITY_NAMES] = entity_names
+
+    def _get_device_or_entity_name(
+        self,
+        entity_id: str,
+    ) -> str:
+        """Get the device or entity name."""
+        entity_registry = er.async_get(self.hass)
+        entity_entry = entity_registry.async_get(entity_id)
+        if not entity_entry:
+            return entity_id
+        if entity_entry.device_id:
+            device_registry = dr.async_get(self.hass)
+            device_entry = device_registry.async_get(device_id=entity_entry.device_id)
+            if device_entry is not None:
+                return f"{device_entry.name_by_user or device_entry.name} ({entity_entry.name or entity_entry.original_name or entity_id})"
+        return entity_entry.name or entity_entry.original_name or entity_id

custom_components/label_state/const.py

@@ -31,6 +31,7 @@
 CONF_STATE_UPPER_LIMIT = "state_upper_limit"
 
 ATTR_ENTITIES = "entities"
+ATTR_ENTITY_NAMES = "entity_names"
 
 
 class StateTypes(StrEnum):