Add area_name attribute to battery notes services and coordinator (#4924)

Author: andrew-codechimp

custom_components/battery_notes/const.py

@@ -76,6 +76,7 @@
 EVENT_BATTERY_NOT_REPORTED = "battery_notes_battery_not_reported"
 EVENT_BATTERY_REPLACED = "battery_notes_battery_replaced"
 
+ATTR_AREA_NAME = "area_name"
 ATTR_DEVICE_ID = "device_id"
 ATTR_SOURCE_ENTITY_ID = "source_entity_id"
 ATTR_REMOVE = "remove"

custom_components/battery_notes/coordinator.py

@@ -21,6 +21,7 @@
 )
 from homeassistant.core import CALLBACK_TYPE, HomeAssistant, callback
 from homeassistant.helpers import (
+    area_registry as ar,
     device_registry as dr,
     entity_registry as er,
     issue_registry as ir,
@@ -431,6 +432,27 @@ def source_entity_name(self):
 
         return self._source_entity_name
 
+    @property
+    def area_name(self):
+        """Get the area name of the source_entity_id or device_id."""
+        if self.source_entity_id:
+            entity_registry = er.async_get(self.hass)
+            registry_entry = entity_registry.async_get(self.source_entity_id)
+            if registry_entry and registry_entry.area_id:
+                area_registry = ar.async_get(self.hass)
+                area_entry = area_registry.async_get_area(registry_entry.area_id)
+                if area_entry:
+                    return area_entry.name
+        elif self.device_id:
+            device_registry = dr.async_get(self.hass)
+            device_entry = device_registry.async_get(self.device_id)
+            if device_entry and device_entry.area_id:
+                area_registry = ar.async_get(self.hass)
+                area_entry = area_registry.async_get_area(device_entry.area_id)
+                if area_entry:
+                    return area_entry.name
+        return None
+
     @property
     def battery_low_template_state(self):
         """Get the current battery low status from a templated device."""

custom_components/battery_notes/services.py

@@ -15,6 +15,7 @@
 from homeassistant.util import dt as dt_util
 
 from .const import (
+    ATTR_AREA_NAME,
     ATTR_BATTERY_LAST_REPLACED,
     ATTR_BATTERY_LAST_REPLACED_DAYS,
     ATTR_BATTERY_LAST_REPORTED,
@@ -272,6 +273,7 @@ async def _async_battery_last_replaced(call: ServiceCall) -> ServiceResponse:
                                 ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id
                                 or "",
                                 ATTR_DEVICE_NAME: coordinator.device_name,
+                                ATTR_AREA_NAME: coordinator.area_name,
                                 ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,
                                 ATTR_BATTERY_TYPE: coordinator.battery_type,
                                 ATTR_BATTERY_QUANTITY: coordinator.battery_quantity,
@@ -292,6 +294,7 @@ async def _async_battery_last_replaced(call: ServiceCall) -> ServiceResponse:
                             ATTR_DEVICE_ID: coordinator.device_id or "",
                             ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id or "",
                             ATTR_DEVICE_NAME: coordinator.device_name,
+                            ATTR_AREA_NAME: coordinator.area_name,
                             ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,
                             ATTR_BATTERY_TYPE: coordinator.battery_type,
                             ATTR_BATTERY_QUANTITY: coordinator.battery_quantity,
@@ -352,6 +355,7 @@ async def _async_battery_last_reported(call: ServiceCall) -> ServiceResponse:
                                 ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id
                                 or "",
                                 ATTR_DEVICE_NAME: coordinator.device_name,
+                                ATTR_AREA_NAME: coordinator.area_name,
                                 ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,
                                 ATTR_BATTERY_TYPE: coordinator.battery_type,
                                 ATTR_BATTERY_QUANTITY: coordinator.battery_quantity,
@@ -372,6 +376,7 @@ async def _async_battery_last_reported(call: ServiceCall) -> ServiceResponse:
                             ATTR_DEVICE_ID: coordinator.device_id or "",
                             ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id or "",
                             ATTR_DEVICE_NAME: coordinator.device_name,
+                            ATTR_AREA_NAME: coordinator.area_name,
                             ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,
                             ATTR_BATTERY_TYPE: coordinator.battery_type,
                             ATTR_BATTERY_QUANTITY: coordinator.battery_quantity,
@@ -411,6 +416,7 @@ async def _async_battery_low(call: ServiceCall) -> ServiceResponse:
                             ATTR_DEVICE_ID: coordinator.device_id or "",
                             ATTR_DEVICE_NAME: coordinator.device_name,
                             ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id or "",
+                            ATTR_AREA_NAME: coordinator.area_name,
                             ATTR_BATTERY_LOW: coordinator.battery_low,
                             ATTR_BATTERY_LOW_THRESHOLD: coordinator.battery_low_threshold,
                             ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,
@@ -431,6 +437,7 @@ async def _async_battery_low(call: ServiceCall) -> ServiceResponse:
                         ATTR_DEVICE_ID: coordinator.device_id or "",
                         ATTR_DEVICE_NAME: coordinator.device_name,
                         ATTR_SOURCE_ENTITY_ID: coordinator.source_entity_id or "",
+                        ATTR_AREA_NAME: coordinator.area_name,
                         ATTR_BATTERY_LOW: coordinator.battery_low,
                         ATTR_BATTERY_LOW_THRESHOLD: coordinator.battery_low_threshold,
                         ATTR_BATTERY_TYPE_AND_QUANTITY: coordinator.battery_type_and_quantity,