Merge pull request #14 from andrew-codechimp/attributes

Attributes

Author: andrew-codechimp

README.md

@@ -98,6 +98,8 @@ for:
   seconds: 0
 ```
 
+- For advanced automations the state of the motion and door sensors are exposed as attributes within the binary sensor.
+
 ---
 
 [commits-shield]: https://img.shields.io/github/commit-activity/y/andrew-codechimp/HA-Wasp-In-A-Box.svg?style=for-the-badge

custom_components/wasp_in_a_box/binary_sensor.py

@@ -25,6 +25,8 @@
 )
 
 from .const import (
+    ATTR_DOOR_SENSOR_STATE,
+    ATTR_MOTION_SENSOR_STATE,
     CONF_BOX_ID,
     CONF_DOOR_CLOSED_DELAY,
     CONF_DOOR_OPEN_TIMEOUT,
@@ -70,6 +72,7 @@ class WaspInABoxSensor(BinarySensorEntity):
 
     _attr_device_class = BinarySensorDeviceClass.OCCUPANCY
     _attr_should_poll = False
+    _attr_translation_key = "wasp_in_a_box"
     _state_had_real_change = False
     _wasp_state: str = STATE_UNKNOWN
     _box_state: str = STATE_UNKNOWN
@@ -179,6 +182,14 @@ def is_on(self) -> bool | None:
         # Convert state to boolean - "on" means occupied
         return self._state == STATE_ON
 
+    @property
+    def extra_state_attributes(self) -> dict[str, str]:
+        """Return state attributes."""
+        return {
+            ATTR_MOTION_SENSOR_STATE: self._wasp_state,
+            ATTR_DOOR_SENSOR_STATE: self._box_state,
+        }
+
     @callback
     def _async_wasp_state_listener(self, event: Event[EventStateChangedData]) -> None:
         """Handle the wasp sensor state changes."""

custom_components/wasp_in_a_box/const.py

@@ -21,3 +21,6 @@
 DEFAULT_DOOR_CLOSED_DELAY = 30
 DEFAULT_OPEN_DOOR_TIMEOUT = 300
 DEFAULT_IMMEDIATE_ON = True
+
+ATTR_MOTION_SENSOR_STATE = "motion_sensor_state"
+ATTR_DOOR_SENSOR_STATE = "door_sensor_state"

custom_components/wasp_in_a_box/translations/en.json

@@ -41,5 +41,29 @@
                 }
             }
         }
+    },
+    "entity": {
+        "binary_sensor": {
+            "wasp_in_a_box": {
+                "state_attributes": {
+                    "motion_sensor_state": {
+                        "name": "Motion sensor state",
+                        "state": {
+                            "on": "Motion detected",
+                            "off": "No motion",
+                            "unknown": "Unknown"
+                        }
+                    },
+                    "door_sensor_state": {
+                        "name": "Door sensor state",
+                        "state": {
+                            "on": "Open",
+                            "off": "Closed",
+                            "unknown": "Unknown"
+                        }
+                    }
+                }
+            }
+        }
     }
 }