Merge pull request #15 from andrew-codechimp/reset-action

Reset action

Author: andrew-codechimp

README.md

@@ -43,6 +43,9 @@ Control when the helper transitions to "occupied":
 - **On** - Helper becomes occupied immediately when the door is opened or motion is detected (good for lighting automation)
 - **Off** - Helper becomes occupied after the door closes, motion is detected, and the delay period expires (good for fan automation)
 
+**Reset action**
+A reset action is provided that will set the state to unoccupied and cancel any timers.
+
 
 _Please :star: this repo if you find it useful_
 
@@ -100,6 +103,8 @@ for:
 
 - For advanced automations the state of the motion and door sensors are exposed as attributes within the binary sensor.
 
+- A reset action is provided if you wish to reset the Wasp in a Box sensor to unoccupied.
+
 ---
 
 [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

@@ -18,7 +18,10 @@
     callback,
 )
 from homeassistant.helpers import entity_registry as er
-from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+from homeassistant.helpers.entity_platform import (
+    AddConfigEntryEntitiesCallback,
+    async_get_current_platform,
+)
 from homeassistant.helpers.event import (
     async_call_later,
     async_track_state_change_event,
@@ -33,6 +36,7 @@
     CONF_IMMEDIATE_ON,
     CONF_WASP_ID,
     LOGGER,
+    SERVICE_RESET,
 )
 
 
@@ -64,6 +68,14 @@ async def async_setup_entry(
         ]
     )
 
+    # Register entity services
+    platform = async_get_current_platform()
+    platform.async_register_entity_service(
+        SERVICE_RESET,
+        {},
+        "async_reset",
+    )
+
     return True
 
 
@@ -356,3 +368,20 @@ def async_calculate_state(self) -> None:
         self._motion_was_detected = motion_detected
 
         self.async_write_ha_state()
+
+    async def async_reset(self) -> None:
+        """Reset the occupancy sensor to off."""
+
+        # Cancel any pending timers
+        if self._door_closed_delay_timer is not None:
+            self._door_closed_delay_timer()
+            self._door_closed_delay_timer = None
+
+        if self._door_open_timeout_timer is not None:
+            self._door_open_timeout_timer()
+            self._door_open_timeout_timer = None
+
+        # Reset internal state
+        self._motion_was_detected = False
+        self._state = STATE_OFF
+        self.async_write_ha_state()

custom_components/wasp_in_a_box/const.py

@@ -24,3 +24,4 @@
 
 ATTR_MOTION_SENSOR_STATE = "motion_sensor_state"
 ATTR_DOOR_SENSOR_STATE = "door_sensor_state"
+SERVICE_RESET = "reset"

custom_components/wasp_in_a_box/icons.json

@@ -0,0 +1,7 @@
+{
+    "services": {
+        "reset": {
+            "service": "mdi:refresh"
+        }
+    }
+}

custom_components/wasp_in_a_box/services.yaml

@@ -0,0 +1,8 @@
+# Services for Wasp in a Box integration
+reset:
+  name: Reset
+  description: Reset the occupancy sensor to off and clear any pending timers.
+  target:
+    entity:
+      integration: wasp_in_a_box
+      domain: binary_sensor

custom_components/wasp_in_a_box/translations/en.json

@@ -65,5 +65,11 @@
                 }
             }
         }
+    },
+    "services": {
+        "reset": {
+            "name": "Reset",
+            "description": "Reset the occupancy sensor to off and clear any pending timers."
+        }
     }
 }