1.0.4

Author: jneilliii

octoprint_tplinksmartplug/__init__.py

@@ -103,6 +103,10 @@ def __init__(self):
 		self.poll_status = None
 		self.power_off_queue = []
 		self._gcode_queued = False
+		self.active_timers = {"on": {}, "off": {}}
+		self.total_correction = 0
+		self.last_row = [0,0,0,0,0,0,0]
+		self.last_row_entered = False
 
 	##~~ StartupPlugin mixin
 
@@ -124,9 +128,38 @@ def on_startup(self, host, port):
 			db = sqlite3.connect(self.db_path)
 			cursor = db.cursor()
 			cursor.execute(
-				'''CREATE TABLE energy_data(id INTEGER PRIMARY KEY, ip TEXT, timestamp TEXT, current REAL, power REAL, total REAL, voltage REAL)''')
+				'''CREATE TABLE energy_data(id INTEGER PRIMARY KEY, ip TEXT, timestamp DATETIME, voltage REAL, current REAL, power REAL, total REAL, grandtotal REAL)''')
+		else:
+			db = sqlite3.connect(self.db_path)
+			cursor = db.cursor()
+
+		#Update 'energy_data' table schema if 'grandtotal' column not present
+		cursor.execute('''SELECT * FROM energy_data''')
+		if 'grandtotal' not in next(zip(*cursor.description)):
+			#Change type of 'timestamp' to 'DATETIME' (from 'TEXT'), add new 'grandtotal' column
+			cursor.execute('''
+				ALTER TABLE energy_data RENAME TO _energy_data''')
+			cursor.execute('''
+				CREATE TABLE energy_data (id INTEGER PRIMARY KEY, ip TEXT, timestamp DATETIME, voltage REAL, current REAL, power REAL, total REAL, grandtotal REAL)''')
+			#Copy over table, skipping non-changed values and calculating running grandtotal
+			cursor.execute('''
+				INSERT INTO energy_data (ip, timestamp, voltage, current, power, total, grandtotal) SELECT ip, timestamp, voltage, current, power, total, grandtotal FROM
+					(WITH temptable AS (SELECT *, total - LAG(total,1) OVER(ORDER BY id) AS delta, LAG(power,1) OVER(ORDER BY id) AS power1 FROM _energy_data)
+					SELECT *, ROUND(SUM(MAX(delta,0)) OVER (ORDER BY id ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW),6)
+					AS grandtotal FROM temptable WHERE power > 0 OR power1 > 0 OR delta <> 0 OR delta IS NULL)''')
+
+			cursor.execute('''DROP TABLE _energy_data''')
+			#Compact database
 			db.commit()
-			db.close()
+			cursor.execute('''VACUUM''')
+
+		self.last_row = list(cursor.execute('''SELECT id, timestamp, voltage, current, power, total, grandtotal
+			FROM energy_data ORDER BY ROWID DESC LIMIT 1''').fetchone() or [0,0,0,0,0,0,0]) #Round to remove floating point imprecision
+		self.last_row = self.last_row[:2] + [round(x,6) for x in self.last_row[2:]] #Round to correct floating point imprecision in sqlite
+		self.last_row_entered = True
+		self.total_correction = self.last_row[6] - self.last_row[5] #grandtotal - total
+		db.commit()
+		db.close()
 
 	def on_after_startup(self):
 		self._logger.info("TPLinkSmartplug loaded!")
@@ -143,7 +176,7 @@ def on_after_startup(self):
 		self.idleTimeout = self._settings.get_int(["idleTimeout"])
 		self._tplinksmartplug_logger.debug("idleTimeout: %s" % self.idleTimeout)
 		self.idleIgnoreCommands = self._settings.get(["idleIgnoreCommands"])
-		self._idleIgnoreCommandsArray = self.idleIgnoreCommands.split(',')
+		self._idleIgnoreCommandsArray = self.idleIgnoreCommands.replace(" ", "").split(',')
 		self._tplinksmartplug_logger.debug("idleIgnoreCommands: %s" % self.idleIgnoreCommands)
 		self.idleTimeoutWaitTemp = self._settings.get_int(["idleTimeoutWaitTemp"])
 		self._tplinksmartplug_logger.debug("idleTimeoutWaitTemp: %s" % self.idleTimeoutWaitTemp)
@@ -158,6 +191,22 @@ def on_after_startup(self):
 					else:
 						self._tplinksmartplug_logger.debug("powering on %s during startup failed." % (plug["ip"]))
 		self._reset_idle_timer()
+		self.loaded = True
+
+	def on_connect(self, *args, **kwargs): #Power up on connect
+		if hasattr(self, 'loaded') is False: return None
+		if self._settings.get_boolean(["connect_on_connect_request"]) is True:
+			self._tplinksmartplug_logger.debug("powering on due to 'Connect' request.")
+			for plug in self._settings.get(['arrSmartplugs']):
+				if plug["connect_on_connect"] is True and self._printer.is_closed_or_error():
+					self._tplinksmartplug_logger.debug("powering on %s due to 'Connect' request." % (plug["ip"]))
+					response = self.turn_on(plug["ip"])
+					if response.get("currentState", False) == "on":
+						self._tplinksmartplug_logger.debug("powering on %s during 'Connect' succeeded." % (plug["ip"]))
+						self._plugin_manager.send_plugin_message(self._identifier, response)
+					else:
+						self._tplinksmartplug_logger.debug("powering on %s during 'Connect' failed." % (plug["ip"]))
+		return None
 
 	##~~ SettingsPlugin mixin
 
@@ -168,7 +217,7 @@ def get_settings_defaults(self):
 				'event_on_upload_monitoring': False, 'event_on_upload_monitoring_always': False,
 				'event_on_startup_monitoring': False, 'event_on_shutdown_monitoring': False, 'cost_rate': 0,
 				'abortTimeout': 30, 'powerOffWhenIdle': False, 'idleTimeout': 30, 'idleIgnoreCommands': 'M105',
-				'idleTimeoutWaitTemp': 50, 'progress_polling': False, 'useDropDown': False}
+				'idleIgnoreHeaters': '', 'idleTimeoutWaitTemp': 50, 'progress_polling': False, 'useDropDown': False}
 
 	def on_settings_save(self, data):
 		old_debug_logging = self._settings.get_boolean(["debug_logging"])
@@ -186,7 +235,7 @@ def on_settings_save(self, data):
 
 		self.idleTimeout = self._settings.get_int(["idleTimeout"])
 		self.idleIgnoreCommands = self._settings.get(["idleIgnoreCommands"])
-		self._idleIgnoreCommandsArray = self.idleIgnoreCommands.split(',')
+		self._idleIgnoreCommandsArray = self.idleIgnoreCommands.replace(" ", "").split(',')
 		self.idleTimeoutWaitTemp = self._settings.get_int(["idleTimeoutWaitTemp"])
 
 		if self.powerOffWhenIdle != old_powerOffWhenIdle:
@@ -511,18 +560,43 @@ def check_status(self, plugip):
 						p = ""
 					if "total_wh" in emeter_data["get_realtime"]:
 						t = emeter_data["get_realtime"]["total_wh"] / 1000.0
+						emeter_data["get_realtime"]["total_wh"] += self.total_correction * 1000.0 #Add back total correction factor, so becomes grandtotal
 					elif "total" in emeter_data["get_realtime"]:
 						t = emeter_data["get_realtime"]["total"]
+						emeter_data["get_realtime"]["total"] += self.total_correction  #Add back total correction factor, so becomes grandtotal
 					else:
 						t = ""
 					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])
-						db.commit()
-						db.close()
+						last_p = self.last_row[4]
+						last_t = self.last_row[5]
+
+						if last_t is not None and t < last_t: #total has reset since last measurement
+							self.total_correction += last_t
+						gt = round(t + self.total_correction, 6) #Prevent accumulated floating-point rounding errors
+						current_row = [plugip, today.isoformat(' '), v, c, p, t, gt]
+
+						if self.last_row_entered is False and last_p == 0 and p > 0: #Go back & enter last_row on power return (if not entered already)
+							db = sqlite3.connect(self.db_path)
+							cursor = db.cursor()
+							cursor.execute(
+								'''INSERT INTO energy_data(ip, timestamp, voltage, current, power, total, grandtotal) VALUES(?,?,?,?,?,?,?)''',
+								self.last_row)
+							db.commit()
+							db.close()
+							self.last_row_entered = True
+						else:
+							self.last_row_entered = False
+
+						if t != last_t or p > 0 or last_p > 0: #Enter current_row if change in total or power is on or just turned off
+							db = sqlite3.connect(self.db_path)
+							cursor = db.cursor()
+							cursor.execute(
+								'''INSERT INTO energy_data(ip, timestamp, voltage, current, power, total, grandtotal) VALUES(?,?,?,?,?,?,?)''',
+								current_row)
+							db.commit()
+							db.close()
+
+						self.last_row = current_row
 
 			if len(plug_ip) == 2:
 				chk = self.lookup(response, *["system", "get_sysinfo", "children"])
@@ -572,7 +646,7 @@ def on_api_command(self, command, data):
 			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 ?,?''',
+				'''SELECT timestamp, current, power, grandtotal, 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()
@@ -704,7 +778,7 @@ def on_event(self, event, payload):
 
 			hours = (payload.get("time", 0) / 60) / 60
 			self._tplinksmartplug_logger.debug("hours: %s" % hours)
-			power_used = self.print_job_power * hours
+			power_used = self.print_job_power
 			self._tplinksmartplug_logger.debug("power used: %s" % power_used)
 			power_cost = power_used * self._settings.get_float(["cost_rate"])
 			self._tplinksmartplug_logger.debug("power total cost: %s" % power_cost)
@@ -747,7 +821,7 @@ def on_event(self, event, payload):
 		# File Uploaded Event
 		if event == Events.UPLOAD and self._settings.get_boolean(["event_on_upload_monitoring"]):
 			if payload.get("print", False) or self._settings.get_boolean(
-					["event_on_upload_monitoring_always"]):  # implemented in OctoPrint version 1.4.1
+					["event_on_upload_monitoring_always"]):	 # 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(payload)
@@ -849,11 +923,12 @@ def _wait_for_timelapse(self):
 	def _wait_for_heaters(self):
 		self._waitForHeaters = True
 		heaters = self._printer.get_current_temperatures()
+		ignored_heaters = self._settings.get(["idleIgnoreHeaters"]).replace(" ", "").split(',')
 
 		for heater, entry in heaters.items():
 			target = entry.get("target")
-			if target is None:
-				# heater doesn't exist in fw
+			if target is None or heater in ignored_heaters:
+				# heater doesn't exist in fw or set to be ignored
 				continue
 
 			try:
@@ -879,7 +954,7 @@ def _wait_for_heaters(self):
 			highest_temp = 0
 			heaters_above_waittemp = []
 			for heater, entry in heaters.items():
-				if not heater.startswith("tool"):
+				if not heater.startswith("tool") or heater in ignored_heaters:
 					continue
 
 				actual = entry.get("actual")
@@ -1060,6 +1135,10 @@ def sendCommand(self, cmd, plugip, plug_num=0):
 	##~~ Gcode processing hook
 
 	def gcode_turn_off(self, plug):
+		if plug["ip"] in self.active_timers["off"]:
+			self.active_timers["off"][plug["ip"]].cancel()
+			del self.active_timers["off"][plug["ip"]]
+
 		if self._printer.is_printing() and plug["warnPrinting"] is True:
 			self._tplinksmartplug_logger.debug(
 				"Not powering off %s immediately because printer is printing." % plug["label"])
@@ -1068,7 +1147,12 @@ def gcode_turn_off(self, plug):
 			chk = self.turn_off(plug["ip"])
 			self._plugin_manager.send_plugin_message(self._identifier, chk)
 
+
 	def gcode_turn_on(self, plug):
+		if plug["ip"] in self.active_timers["on"]:
+			self.active_timers["on"][plug["ip"]].cancel()
+			del self.active_timers["on"][plug["ip"]]
+
 		chk = self.turn_on(plug["ip"])
 		self._plugin_manager.send_plugin_message(self._identifier, chk)
 
@@ -1108,19 +1192,25 @@ def processAtCommand(self, comm_instance, phase, command, parameters, tags=None,
 			plug = self.plug_search(self._settings.get(["arrSmartplugs"]), "ip", plugip)
 			self._tplinksmartplug_logger.debug(plug)
 			if plug and plug["gcodeEnabled"]:
-				t = threading.Timer(int(plug["gcodeOnDelay"]), self.gcode_turn_on, [plug])
-				t.daemon = True
-				t.start()
+				if plugip in self.active_timers["off"]:
+					self.active_timers["off"][plugip].cancel()
+					del self.active_timers["off"][plugip]
+				self.active_timers["on"][plugip] = threading.Timer(int(plug["gcodeOnDelay"]), self.gcode_turn_on, [plug])
+				self.active_timers["on"][plugip].daemon = True
+				self.active_timers["on"][plugip].start()
 			return None
 		if command == "TPLINKOFF":
 			plugip = parameters
 			self._tplinksmartplug_logger.debug("Received TPLINKOFF command, attempting power off of %s." % plugip)
 			plug = self.plug_search(self._settings.get(["arrSmartplugs"]), "ip", plugip)
 			self._tplinksmartplug_logger.debug(plug)
 			if plug and plug["gcodeEnabled"]:
-				t = threading.Timer(int(plug["gcodeOffDelay"]), self.gcode_turn_off, [plug])
-				t.daemon = True
-				t.start()
+				if plugip in self.active_timers["on"]:
+					self.active_timers["on"][plugip].cancel()
+					del self.active_timers["on"][plugip]
+				self.active_timers["off"][plugip] = threading.Timer(int(plug["gcodeOffDelay"]), self.gcode_turn_off, [plug])
+				self.active_timers["off"][plugip].daemon = True
+				self.active_timers["off"][plugip].start()
 			return None
 		if command == 'TPLINKIDLEON':
 			self.powerOffWhenIdle = True
@@ -1215,5 +1305,6 @@ def __plugin_load__():
 		"octoprint.comm.protocol.atcommand.sending": __plugin_implementation__.processAtCommand,
 		"octoprint.comm.protocol.temperatures.received": __plugin_implementation__.monitor_temperatures,
 		"octoprint.access.permissions": __plugin_implementation__.get_additional_permissions,
-		"octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
+		"octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information,
+		"octoprint.printer.handle_connect": __plugin_implementation__.on_connect
 	}

octoprint_tplinksmartplug/static/js/tplinksmartplug.js

@@ -396,7 +396,7 @@ $(function() {
 							trace_total.x.push(row[0]);
 							trace_total.y.push(row[3]);
 							trace_cost.x.push(row[0]);
-							trace_cost.y.push(row[3]*self.settings.settings.plugins.tplinksmartplug.cost_rate());
+							trace_cost.y.push((row[3]*self.settings.settings.plugins.tplinksmartplug.cost_rate()).toFixed(3));
 						});
 						var layout = {title:'TP-Link Smartplug Energy Data',
 									grid: {rows: 2, columns: 1, pattern: 'independent'},

octoprint_tplinksmartplug/templates/tplinksmartplug_settings.jinja2

@@ -183,6 +183,14 @@
 				</div>
 			</div>
 		</div>
+		<div class="row-fluid">
+			<div class="control-group">
+				<label class="control-label">{{ _('Heaters to Ignore for Idle') }}</label>
+				<div class="controls" data-toggle="tooltip" data-bind="tooltip: {}" title="{{ _('Comma separated list of heaters to ignore for idle temperature. ie, for Prusa MK4 include X.') }}">
+					<input type="text" class="input-block-level" data-bind="value: settings.settings.plugins.tplinksmartplug.idleIgnoreHeaters, enable: settings.settings.plugins.tplinksmartplug.powerOffWhenIdle() && settings.settings.plugins.tplinksmartplug.powerOffWhenIdle()" disabled />
+				</div>
+			</div>
+		</div>
 		<div class="row-fluid">
 			<div class="control-group">
 				<label class="control-label">{{ _('GCode Commands to Ignore for Idle') }}</label>

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