move idle timer stop to system shutdown function instead of in turn off function to resolve issues related to multiple plugs, #254

Author: jneilliii

octoprint_tplinksmartplug/__init__.py

@@ -2,8 +2,8 @@
 from __future__ import absolute_import
 
 import octoprint.plugin
-from octoprint.access.permissions import Permissions, ADMIN_GROUP, USER_GROUP
-from octoprint.events import eventManager, Events
+from octoprint.access.permissions import Permissions, ADMIN_GROUP
+from octoprint.events import Events
 from octoprint.util import RepeatedTimer
 from flask_babel import gettext
 import socket
@@ -15,7 +15,6 @@
 import threading
 import time
 import sqlite3
-import decimal
 from uptime import uptime
 from datetime import datetime
 from struct import unpack
@@ -221,6 +220,7 @@ def on_settings_save(self, data):
 		if old_polling_value != new_polling_value or old_polling_timer != new_polling_timer:
 			if self.poll_status is not None:
 				self.poll_status.cancel()
+				self.poll_status = None
 
 			if new_polling_value:
 				self.poll_status = RepeatedTimer(int(self._settings.get(["pollingInterval"])) * 60, self.check_statuses)
@@ -299,11 +299,17 @@ def on_settings_migrate(self, target, current=None):
 
 	def get_assets(self):
 		return dict(
-			js=["js/jquery-ui.min.js", "js/knockout-sortable.1.2.0.js", "js/fontawesome-iconpicker.js",
+			js=["js/jquery-ui.min.js",
+				"js/knockout-sortable.1.2.0.js",
+				"js/fontawesome-iconpicker.js",
 				"js/ko.iconpicker.js",
-				"js/tplinksmartplug.js", "js/knockout-bootstrap.min.js", "js/ko.observableDictionary.js",
+				"js/tplinksmartplug.js",
+				"js/knockout-bootstrap.min.js",
+				"js/ko.observableDictionary.js",
 				"js/plotly-latest.min.js"],
-			css=["css/font-awesome.min.css", "css/font-awesome-v4-shims.min.css", "css/fontawesome-iconpicker.css",
+			css=["css/font-awesome.min.css",
+				 "css/font-awesome-v4-shims.min.css",
+				 "css/fontawesome-iconpicker.css",
 				 "css/tplinksmartplug.css"]
 		)
 
@@ -330,7 +336,7 @@ def on_print_progress(self, storage, path, progress):
 		_print_progress_timer.start()
 		self._plugin_manager.send_plugin_message(self._identifier, dict(updatePlot=True))
 
-		if self.powerOffWhenIdle == True and not (self._skipIdleTimer == True):
+		if self.powerOffWhenIdle is True and not (self._skipIdleTimer is True):
 			self._tplinksmartplug_logger.debug("Resetting idle timer during print progress (%s)..." % progress)
 			self._waitForHeaters = False
 			self._reset_idle_timer()
@@ -348,19 +354,15 @@ def turn_on(self, plugip):
 			plug_num = -1
 		if plug["useCountdownRules"] and int(plug["countdownOnDelay"]) > 0:
 			self.sendCommand(json.loads('{"count_down":{"delete_all_rules":null}}'), plug_ip, plug_num)
-			chk = self.lookup(self.sendCommand(json.loads(
-				'{"count_down":{"add_rule":{"enable":1,"delay":%s,"act":1,"name":"turn on"}}}' % plug[
-					"countdownOnDelay"]), plug_ip, plug_num), *["count_down", "add_rule", "err_code"])
+			chk = self.lookup(self.sendCommand(json.loads('{"count_down":{"add_rule":{"enable":1,"delay":%s,"act":1,"name":"turn on"}}}' % plug["countdownOnDelay"]), plug_ip, plug_num), *["count_down", "add_rule", "err_code"])
 			if chk == 0:
 				self._countdown_active = True
-				c = threading.Timer(int(plug["countdownOnDelay"]) + 3, self._plugin_manager.send_plugin_message,
-									[self._identifier, dict(check_status=True, ip=plugip)])
+				c = threading.Timer(int(plug["countdownOnDelay"]) + 3, self._plugin_manager.send_plugin_message, [self._identifier, dict(check_status=True, ip=plugip)])
 				c.daemon = True
 				c.start()
 		else:
 			turn_on_cmnd = dict(system=dict(set_relay_state=dict(state=1)))
-			chk = self.lookup(self.sendCommand(turn_on_cmnd, plug_ip, plug_num),
-							  *["system", "set_relay_state", "err_code"])
+			chk = self.lookup(self.sendCommand(turn_on_cmnd, plug_ip, plug_num), *["system", "set_relay_state", "err_code"])
 
 		self._tplinksmartplug_logger.debug(chk)
 		if chk == 0:
@@ -372,7 +374,7 @@ def turn_on(self, plugip):
 				t = threading.Timer(int(plug["sysCmdOnDelay"]), os.system, args=[plug["sysRunCmdOn"]])
 				t.daemon = True
 				t.start()
-			if self.powerOffWhenIdle == True and plug["automaticShutdownEnabled"] == True:
+			if self.powerOffWhenIdle is True and plug["automaticShutdownEnabled"] is True:
 				self._tplinksmartplug_logger.debug("Resetting idle timer since plug %s was just turned on." % plugip)
 				self._waitForHeaters = False
 				self._reset_idle_timer()
@@ -392,13 +394,10 @@ def turn_off(self, plugip):
 			plug_num = -1
 		if plug["useCountdownRules"] and int(plug["countdownOffDelay"]) > 0:
 			self.sendCommand(json.loads('{"count_down":{"delete_all_rules":null}}'), plug_ip, plug_num)
-			chk = self.lookup(self.sendCommand(json.loads(
-				'{"count_down":{"add_rule":{"enable":1,"delay":%s,"act":0,"name":"turn off"}}}' % plug[
-					"countdownOffDelay"]), plug_ip, plug_num), *["count_down", "add_rule", "err_code"])
+			chk = self.lookup(self.sendCommand(json.loads('{"count_down":{"add_rule":{"enable":1,"delay":%s,"act":0,"name":"turn off"}}}' % plug["countdownOffDelay"]), plug_ip, plug_num), *["count_down", "add_rule", "err_code"])
 			if chk == 0:
 				self._countdown_active = True
-				c = threading.Timer(int(plug["countdownOffDelay"]) + 3, self._plugin_manager.send_plugin_message,
-									[self._identifier, dict(check_status=True, ip=plugip)])
+				c = threading.Timer(int(plug["countdownOffDelay"]) + 3, self._plugin_manager.send_plugin_message, [self._identifier, dict(check_status=True, ip=plugip)])
 				c.start()
 
 		if plug["sysCmdOff"]:
@@ -411,12 +410,10 @@ def turn_off(self, plugip):
 
 		if not plug["useCountdownRules"]:
 			turn_off_cmnd = dict(system=dict(set_relay_state=dict(state=0)))
-			chk = self.lookup(self.sendCommand(turn_off_cmnd, plug_ip, plug_num),
-							  *["system", "set_relay_state", "err_code"])
+			chk = self.lookup(self.sendCommand(turn_off_cmnd, plug_ip, plug_num), *["system", "set_relay_state", "err_code"])
 
 		self._tplinksmartplug_logger.debug(chk)
 		if chk == 0:
-			self._stop_idle_timer()
 			return self.check_status(plugip)
 
 	def check_statuses(self):
@@ -481,9 +478,7 @@ def check_status(self, plugip):
 					if self.db_path is not None:
 						db = sqlite3.connect(self.db_path)
 						cursor = db.cursor()
-						cursor.execute(
-							'''INSERT INTO energy_data(ip, timestamp, current, power, total, voltage) VALUES(?,?,?,?,?,?)''',
-							[plugip, today.isoformat(' '), c, p, t, v])
+						cursor.execute('''INSERT INTO energy_data(ip, timestamp, current, power, total, voltage) VALUES(?,?,?,?,?,?)''',[plugip, today.isoformat(' '), c, p, t, v])
 						db.commit()
 						db.close()
 
@@ -534,9 +529,7 @@ def on_api_command(self, command, data):
 		elif command == 'getEnergyData':
 			db = sqlite3.connect(self.db_path)
 			cursor = db.cursor()
-			cursor.execute(
-				'''SELECT timestamp, current, power, total, voltage FROM energy_data WHERE ip=? ORDER BY timestamp DESC LIMIT ?,?''',
-				(data["ip"], data["record_offset"], data["record_limit"]))
+			cursor.execute('''SELECT timestamp, current, power, total, voltage FROM energy_data WHERE ip=? ORDER BY timestamp DESC LIMIT ?,?''', (data["ip"], data["record_offset"], data["record_limit"]))
 			response = {'energy_data': cursor.fetchall()}
 			db.close()
 			self._tplinksmartplug_logger.debug(response)
@@ -571,16 +564,14 @@ def on_api_command(self, command, data):
 		elif command == "getListPlug":
 			return json.dumps(self._settings.get(["arrSmartplugs"]))
 		else:
-			response = dict(ip=data.ip, currentState="unknown")
+			response = dict(ip="{ip}".format(**data), currentState="unknown")
 		if command == "enableAutomaticShutdown" or command == "disableAutomaticShutdown":
 			self._tplinksmartplug_logger.debug("Automatic power off setting changed: %s" % self.powerOffWhenIdle)
 			self._settings.set_boolean(["powerOffWhenIdle"], self.powerOffWhenIdle)
 			self._settings.save()
 		# eventManager().fire(Events.SETTINGS_UPDATED)
 		if command == "enableAutomaticShutdown" or command == "disableAutomaticShutdown" or command == "abortAutomaticShutdown":
-			self._plugin_manager.send_plugin_message(self._identifier,
-													 dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout",
-														  timeout_value=self._timeout_value))
+			self._plugin_manager.send_plugin_message(self._identifier, dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout", timeout_value=self._timeout_value))
 		else:
 			return flask.jsonify(response)
 
@@ -608,10 +599,9 @@ def on_event(self, event, payload):
 		# Client Opened Event
 		if event == Events.CLIENT_OPENED:
 			if self._settings.get_boolean(["powerOffWhenIdle"]):
+				self._tplinksmartplug_logger.debug("resetting idle timer due to %s event." % event)
 				self._reset_idle_timer()
-			self._plugin_manager.send_plugin_message(self._identifier,
-													 dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout",
-														  timeout_value=self._timeout_value))
+			self._plugin_manager.send_plugin_message(self._identifier, dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout", timeout_value=self._timeout_value))
 			return
 		# Cancelled Print Interpreted Event
 		if event == Events.PRINT_FAILED and not self._printer.is_closed_or_error():
@@ -639,9 +629,7 @@ def on_event(self, event, payload):
 			if self._idleTimer is not None:
 				self._reset_idle_timer()
 			self._timeout_value = None
-			self._plugin_manager.send_plugin_message(self._identifier,
-													 dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout",
-														  timeout_value=self._timeout_value))
+			self._plugin_manager.send_plugin_message(self._identifier, dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout", timeout_value=self._timeout_value))
 
 		if event == Events.PRINT_STARTED and self._countdown_active:
 			for plug in self._settings.get(["arrSmartplugs"]):
@@ -672,8 +660,7 @@ def on_event(self, event, payload):
 			self._tplinksmartplug_logger.debug("power total cost: %s" % power_cost)
 
 			self._storage_interface = self._file_manager._storage(payload.get("origin", "local"))
-			self._storage_interface.set_additional_metadata(payload.get("path"), "statistics", dict(
-				lastPowerCost=dict(_default=float('{:.4f}'.format(power_cost)))), merge=True)
+			self._storage_interface.set_additional_metadata(payload.get("path"), "statistics", dict(lastPowerCost=dict(_default=float('{:.4f}'.format(power_cost)))), merge=True)
 
 			self.print_job_power = 0.0
 			self.print_job_started = False
@@ -696,18 +683,15 @@ def on_event(self, event, payload):
 		# File Uploaded Event
 		if event == Events.UPLOAD and self._settings.getBoolean(["event_on_upload_monitoring"]):
 			if payload.get("print", False):  # implemented in OctoPrint version 1.4.1
-				self._tplinksmartplug_logger.debug(
-					"File uploaded: %s. Turning enabled plugs on." % payload.get("name", ""))
+				self._tplinksmartplug_logger.debug("File uploaded: %s. Turning enabled plugs on." % payload.get("name", ""))
 				self._tplinksmartplug_logger.debug(payload)
 				for plug in self._settings.get(['arrSmartplugs']):
 					self._tplinksmartplug_logger.debug(plug)
 					if plug["event_on_upload"] is True and not self._printer.is_ready():
 						self._tplinksmartplug_logger.debug("powering on %s due to %s event." % (plug["ip"], event))
 						response = self.turn_on(plug["ip"])
 						if response["currentState"] == "on":
-							self._tplinksmartplug_logger.debug(
-								"power on successful for %s attempting connection in %s seconds" % (
-									plug["ip"], plug.get("autoConnectDelay", "0")))
+							self._tplinksmartplug_logger.debug("power on successful for %s attempting connection in %s seconds" % (plug["ip"], plug.get("autoConnectDelay", "0")))
 							self._plugin_manager.send_plugin_message(self._identifier, response)
 							if payload.get("path", False) and payload.get("target") == "local":
 								self._autostart_file = payload.get("path")
@@ -749,14 +733,13 @@ def _idle_poweroff(self):
 		if self._printer.is_printing() or self._printer.is_paused():
 			return
 
-		if (uptime()/60) <= (self._settings.get_int(["idleTimeout"])):
+		if (uptime() / 60) <= (self._settings.get_int(["idleTimeout"])):
 			self._tplinksmartplug_logger.debug("Just booted so wait for time sync.")
-			self._tplinksmartplug_logger.debug("uptime: {}, comparison: {}".format((uptime()/60), (self._settings.get_int(["idleTimeout"]))))
+			self._tplinksmartplug_logger.debug("uptime: {}, comparison: {}".format((uptime() / 60), (self._settings.get_int(["idleTimeout"]))))
 			self._reset_idle_timer()
 			return
 
-		self._tplinksmartplug_logger.debug(
-			"Idle timeout reached after %s minute(s). Turning heaters off prior to powering off plugs." % self.idleTimeout)
+		self._tplinksmartplug_logger.debug("Idle timeout reached after %s minute(s). Turning heaters off prior to powering off plugs." % self.idleTimeout)
 		if self._wait_for_heaters():
 			self._tplinksmartplug_logger.debug("Heaters below temperature.")
 			if self._wait_for_timelapse():
@@ -841,8 +824,7 @@ def _wait_for_heaters(self):
 				self._waitForHeaters = False
 				return True
 
-			self._tplinksmartplug_logger.debug(
-				"Waiting for heaters(%s) before shutting power off..." % ', '.join(heaters_above_waittemp))
+			self._tplinksmartplug_logger.debug("Waiting for heaters(%s) before shutting power off..." % ', '.join(heaters_above_waittemp))
 			time.sleep(5)
 
 	##~~ Abort Power Off Timer
@@ -862,9 +844,7 @@ def _timer_task(self):
 			return
 
 		self._timeout_value -= 1
-		self._plugin_manager.send_plugin_message(self._identifier,
-												 dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout",
-													  timeout_value=self._timeout_value))
+		self._plugin_manager.send_plugin_message(self._identifier, dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout", timeout_value=self._timeout_value))
 		if self._timeout_value <= 0:
 			if self._abort_timer is not None:
 				self._abort_timer.cancel()
@@ -877,6 +857,7 @@ def _shutdown_system(self):
 			if plug.get("automaticShutdownEnabled", False):
 				response = self.turn_off("{ip}".format(**plug))
 				self._plugin_manager.send_plugin_message(self._identifier, response)
+		self._stop_idle_timer()
 
 	##~~ Utilities
 
@@ -1036,8 +1017,6 @@ def processGCODE(self, comm_instance, phase, cmd, cmd_type, gcode, *args, **kwar
 			return
 
 	def processAtCommand(self, comm_instance, phase, command, parameters, tags=None, *args, **kwargs):
-		self._logger.info(command)
-		self._logger.info(parameters)
 		if command == "TPLINKON":
 			plugip = parameters
 			self._tplinksmartplug_logger.debug("Received @TPLINKON command, attempting power on of %s." % plugip)
@@ -1069,9 +1048,7 @@ def processAtCommand(self, comm_instance, phase, command, parameters, tags=None,
 				self._abort_timer = None
 			self._timeout_value = None
 		if command in ["TPLINKIDLEON", "TPLINKIDLEOFF"]:
-			self._plugin_manager.send_plugin_message(self._identifier,
-													 dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout",
-														  timeout_value=self._timeout_value))
+			self._plugin_manager.send_plugin_message(self._identifier, dict(powerOffWhenIdle=self.powerOffWhenIdle, type="timeout", timeout_value=self._timeout_value))
 
 	##~~ Temperatures received hook
 

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.0rc2"
+plugin_version = "1.0.0rc3"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module