Rename attribute

Author: andrew-codechimp

README.md

@@ -11,7 +11,7 @@ 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.
-A `friendly_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.
+A `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
 
@@ -83,7 +83,7 @@ actions:
     data:
       message: >-
         Critical sensors are unavailable {{
-        state_attr('binary_sensor.critical_sensor_unavailable', 'friendly_names') |
+        state_attr('binary_sensor.critical_sensor_unavailable', 'entity_names') |
         join(', ') }}
 mode: single
 ```

custom_components/label_state/binary_sensor.py

@@ -23,7 +23,7 @@
 
 from .const import (
     ATTR_ENTITIES,
-    ATTR_FRIENDLY_NAMES,
+    ATTR_ENTITY_NAMES,
     CONF_LABEL,
     CONF_STATE_LOWER_LIMIT,
     CONF_STATE_NOT,
@@ -266,7 +266,7 @@ def _calc_state(self) -> None:
 
         state_is_on: bool | None = False
         entities_on: list[str] = []
-        friendly_names: list[str] = []
+        entity_names: list[str] = []
 
         entity_registry = er.async_get(self.hass)
 
@@ -285,7 +285,7 @@ def _calc_state(self) -> None:
                         state_is_on = True
                         entities_on.append(entity_id)
                         name = self._get_device_or_entity_name(entity_id)
-                        friendly_names.append(name)
+                        entity_names.append(name)
 
         if self._state_type == StateTypes.NOT_STATE:
             for entity_id in self._state_dict.keys():
@@ -302,7 +302,7 @@ def _calc_state(self) -> None:
                         state_is_on = True
                         entities_on.append(entity_id)
                         name = self._get_device_or_entity_name(entity_id)
-                        friendly_names.append(name)
+                        entity_names.append(name)
 
         if self._state_type == StateTypes.NUMERIC_STATE:
             for entity_id in self._state_dict.keys():
@@ -328,7 +328,7 @@ def _calc_state(self) -> None:
                                     state_is_on = True
                                     entities_on.append(entity_id)
                                     name = self._get_device_or_entity_name(entity_id)
-                                    friendly_names.append(name)
+                                    entity_names.append(name)
 
                                     LOGGER.debug(
                                         "State %s is below lower limit %s and above upper limit %s for %s",
@@ -345,7 +345,7 @@ def _calc_state(self) -> None:
                                     state_is_on = True
                                     entities_on.append(entity_id)
                                     name = self._get_device_or_entity_name(entity_id)
-                                    friendly_names.append(name)
+                                    entity_names.append(name)
 
                                     LOGGER.debug(
                                         "State %s is below lower limit %s for %s",
@@ -361,7 +361,7 @@ def _calc_state(self) -> None:
                                     state_is_on = True
                                     entities_on.append(entity_id)
                                     name = self._get_device_or_entity_name(entity_id)
-                                    friendly_names.append(name)
+                                    entity_names.append(name)
 
                                     LOGGER.debug(
                                         "State %s is above upper limit %s for %s",
@@ -384,7 +384,7 @@ 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_FRIENDLY_NAMES] = friendly_names
+        self._attr_extra_state_attributes[ATTR_ENTITY_NAMES] = entity_names
 
     def _get_device_or_entity_name(
         self,

custom_components/label_state/const.py

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