added shutdown event monitoring, #263

Author: jneilliii

octoprint_tplinksmartplug/__init__.py

@@ -79,7 +79,8 @@ class tplinksmartplugPlugin(octoprint.plugin.SettingsPlugin,
 							octoprint.plugin.SimpleApiPlugin,
 							octoprint.plugin.StartupPlugin,
 							octoprint.plugin.ProgressPlugin,
-							octoprint.plugin.EventHandlerPlugin):
+							octoprint.plugin.EventHandlerPlugin,
+							octoprint.plugin.ShutdownPlugin):
 
 	def __init__(self):
 		self._logger = logging.getLogger("octoprint.plugins.tplinksmartplug")
@@ -157,6 +158,15 @@ def on_after_startup(self):
 						self._tplinksmartplug_logger.debug("powering on %s during startup failed." % (plug["ip"]))
 		self._reset_idle_timer()
 
+	##~~ ShutdownPlugin mixin
+
+	def on_shutdown(self):
+		if self._settings.getBoolean(["event_on_shutdown_monitoring"]):
+			for plug in self._settings.get(['arrSmartplugs']):
+				if plug["event_on_shutdown"] is True:
+					self._tplinksmartplug_logger.debug("powering off %s due to shutdown event." % plug["ip"])
+					self.turn_off(plug["ip"])
+
 	##~~ SettingsPlugin mixin
 
 	def get_settings_defaults(self):
@@ -172,6 +182,7 @@ def get_settings_defaults(self):
 			event_on_disconnect_monitoring=False,
 			event_on_upload_monitoring=False,
 			event_on_startup_monitoring=False,
+			event_on_shutdown_monitoring=False,
 			cost_rate=0,
 			abortTimeout=30,
 			powerOffWhenIdle=False,
@@ -229,7 +240,7 @@ def on_settings_save(self, data):
 				self.poll_status.start()
 
 	def get_settings_version(self):
-		return 15
+		return 16
 
 	def on_settings_migrate(self, target, current=None):
 		if current is None or current < 5:
@@ -316,6 +327,13 @@ def on_settings_migrate(self, target, current=None):
 				arrSmartplugs_new.append(plug)
 			self._settings.set(["arrSmartplugs"], arrSmartplugs_new)
 
+		if current is not None and current < 16:
+			arrSmartplugs_new = []
+			for plug in self._settings.get(['arrSmartplugs']):
+				plug["event_on_shutdown"] = False
+				arrSmartplugs_new.append(plug)
+			self._settings.set(["arrSmartplugs"], arrSmartplugs_new)
+
 	##~~ AssetPlugin mixin
 
 	def get_assets(self):

octoprint_tplinksmartplug/templates/tplinksmartplug_settings.jinja2

@@ -90,6 +90,15 @@
 				</div>
 			</div>
 		</div>
+		<div class="row-fluid">
+			<div class="control-group">
+				<div class="controls">
+					<label class="checkbox">
+					<input type="checkbox" title="{{ _('When enabled plugs with the option enabled will be automatically powered off during OctoPrint shutdown.') }}" data-toggle="tooltip" data-bind="checked: settings.settings.plugins.tplinksmartplug.event_on_shutdown_monitoring, tooltip: {}" /> {{ _('Shutdown Event Monitoring') }}
+					</label>
+				</div>
+			</div>
+		</div>
 		<div class="row-fluid">
 			<div class="control-group">
 				<div class="controls">
@@ -221,7 +230,7 @@
 			<tr>
 				<td><div class="controls"><label class="checkbox"><input type="checkbox" title="{{ _('When enabled the on and off commands will be sent to the plug using timers similar to the Kasa app. This is helpful for when you want to run a system command to cleanly shutdown your pi prior to power it off.') }}" data-toggle="tooltip" data-bind="checked: useCountdownRules, tooltip: {container: '#TPLinkPlugEditor'}"/> {{ _('Use Timers') }}</label></div></td>
 				<td></td>
-				<td></td>
+				<td><div class="controls"><label class="checkbox"><input type="checkbox" title="{{ _('Automatically power off this plug when Shutdown Event Monitoring is enabled.') }}" data-toggle="tooltip" data-bind="checked: event_on_shutdown, enable: $root.settings.settings.plugins.tplinksmartplug.event_on_shutdown_monitoring(), tooltip: {container: '#TPLinkPlugEditor'}" disabled /> {{ _('Off with Shutdown') }}</label></div></td>
 			</tr>
 			<tr>
 				<td><div class="controls"><label class="control-label">{{ _('Timer On Delay') }}</label><div class="input-append" data-toggle="tooltip" data-bind="tooltip: {container: '#TPLinkPlugEditor'}" title="{{ _('Amount of time for Timer to wait before powering on.') }}"><input type="number" min="1" data-bind="value: countdownOnDelay, enable: useCountdownRules()" class="input input-mini" disabled /><span class="add-on">{{ _('secs') }}</span></div></div></td>

setup.py

@@ -14,7 +14,7 @@
 plugin_name = "OctoPrint-TPLinkSmartplug"
 
 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
-plugin_version = "1.0.0rc7"
+plugin_version = "1.0.0rc8"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module