Added force off action

FlyingDiver · Mar 23, 2023 · 35145c3 · 35145c3
1 parent 021e6f7
commit 35145c3
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/Occupatum.indigoPlugin/Contents/Info.plist b/Occupatum.indigoPlugin/Contents/Info.plist
@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
     <key>PluginVersion</key>
-    <string>2022.1.5</string>
+    <string>2022.1.6</string>
     <key>ServerApiVersion</key>
     <string>3.0</string>
     <key>IwsApiVersion</key>

diff --git a/Occupatum.indigoPlugin/Contents/Server Plugin/Actions.xml b/Occupatum.indigoPlugin/Contents/Server Plugin/Actions.xml
@@ -14,6 +14,10 @@
             </Field>
         </ConfigUI>
     </Action>
+    <Action id="forceZoneOff" deviceFilter="self.area">
+        <Name>Force Zone Off</Name>
+        <CallbackMethod>forceZoneOff</CallbackMethod>
+    </Action>
     <Action id="updateActivityZone" deviceFilter="self.activityZone">
         <Name>Update Activity Zone</Name>
         <CallbackMethod>updateActivityZone</CallbackMethod>

diff --git a/Occupatum.indigoPlugin/Contents/Server Plugin/plugin.py b/Occupatum.indigoPlugin/Contents/Server Plugin/plugin.py
@@ -337,6 +337,14 @@ def validate_cancel_timer_action(self, dev_id, props):
         self.logger.debug(f"validate_update_occupancy_zone_action, errors={errors}")
         return (not bool(errors)), errors  # bool(errors) will return False if empty, True if not)
 
+    def validate_force_zone_off_action(self, dev_id):
+        errors = indigo.Dict()
+        if dev_id not in indigo.devices:
+            errors["device"] = "'deviceId' must be included and must represent an existing device"
+
+        self.logger.debug(f"validate_force_zone_off_action, errors={errors}")
+        return (not bool(errors)), errors  # bool(errors) will return False if empty, True if not)
+
     def validate_update_activity_zone_action(self, dev_id, props):
         errors = indigo.Dict()
         if dev_id not in indigo.devices:
@@ -384,7 +392,7 @@ def validate_update_occupancy_zone_action(self, dev_id, props):
         self.logger.debug(f"validate_update_occupancy_zone_action, errors={errors}")
         return (not bool(errors)), errors  # bool(errors) will return False if empty, True if not)
 
-    def cancelTimer(self, action, device,  caller_waiting_for_result=None):
+    def cancelTimer(self, action, device, caller_waiting_for_result=None):
         self.logger.debug(f"cancelTimer, zoneDevice={device.id}, pluginAction={action}")
         reply_dict = indigo.Dict()  # This will hold the status and errors or device details in the appropriate format
         is_valid, errors = self.validate_cancel_timer_action(device.id, action.props)
@@ -407,6 +415,19 @@ def cancelTimer(self, action, device,  caller_waiting_for_result=None):
                 device.updateStateImageOnServer(indigo.kStateImageSel.MotionSensor)
         return reply_dict
 
+    def forceZoneOff(self, action, device, caller_waiting_for_result=None):
+        self.logger.debug(f"forceZoneOff, zoneDevice={device.id}")
+        reply_dict = indigo.Dict()  # This will hold the status and errors or device details in the appropriate format
+        is_valid, errors = self.validate_force_zone_off_action(device.id)
+        reply_dict["status"] = is_valid
+        if not is_valid:
+            self.logger.error(f"Couldn't complete 'forceZoneOff' action because of errors:\n{dict(errors)}")
+            reply_dict["errors"] = errors
+        else:
+            device.updateStateOnServer(key='onOffState', value=False, uiValue="Off")
+            device.updateStateImageOnServer(indigo.kStateImageSel.MotionSensor)
+        return reply_dict
+
     def updateActivityZone(self, plugin_action, zone_device, caller_waiting_for_result=None):
         self.logger.debug(f"updateActivityZone, zoneDevice={zone_device.id}, pluginAction={plugin_action}")
         reply_dict = indigo.Dict()  # This will hold the status and errors or device details in the appropriate format