Added support for PrintTimeGenius plugin

Closes #191

Author: gdombiak

octoprint_octopod/__init__.py

@@ -232,7 +232,7 @@ def get_assets(self):
 	# progress-hook
 	def on_print_progress(self, storage, path, progress):
 		# progress 0 - 100
-		self._job_notifications.on_print_progress(self._settings, progress)
+		self._job_notifications.on_print_progress(self._settings, progress, self._printer)
 		self._live_activities.on_print_progress(self._settings, self._printer)
 
 	# EventHandlerPlugin mixin

octoprint_octopod/base_notification.py

@@ -242,15 +242,25 @@ def _send_arbitrary_notification(self, settings, message, image):
 				return self._alerts.send_alert(settings, apns_token, url, printer_name, message, None, image) < 300
 
 	def _is_printer_printing(self, printer):
-		completion = None
+		(completion, print_time_in_seconds, print_time_left_in_seconds) = self._get_progress_data(printer)
+		# Check that we are in the middle of a print
+		return not(completion is None or completion == 0 or completion == 100)
+
+	def _get_progress_data(self, printer, reported_progress=None):
+		completion = None if reported_progress is None else reported_progress
+		print_time_in_seconds = None
+		print_time_left_in_seconds = None
 		current_data = printer.get_current_data()
 		if "progress" in current_data and current_data["progress"] is not None \
 				and "completion" in current_data["progress"] and current_data["progress"][
 			"completion"] is not None:
-			completion = current_data["progress"]["completion"]
+			print_time_left_in_seconds = current_data["progress"]["printTimeLeft"]
+			print_time_in_seconds = current_data["progress"]["printTime"]
+			completion = current_data["progress"]["completion"] if reported_progress is None else reported_progress
+			# Ugly hack - PrintTimeGenius changed reported completion so we need to use their conversion function
+			completion = self._convert_progress(completion, print_time_in_seconds, print_time_left_in_seconds)
+		return completion, print_time_in_seconds, print_time_left_in_seconds
 
-		# Check that we are in the middle of a print
-		return not(completion is None or completion == 0 or completion == 100)
 
 	@staticmethod
 	def _get_server_url(settings):
@@ -262,3 +272,17 @@ def _get_server_url(settings):
 			if server_url.endswith('/'):
 				server_url = server_url[:-1]
 		return server_url
+
+	def _convert_progress(self, progress, print_time, time_left):
+		"""
+		PrintTimeGenius plugin changed the way progress is calculated. If this plugin is installed then the reported
+		progress by OctoPrint might be wrong and hence needs to be calculated based on printing time.
+		"""
+		if print_time is None or time_left is None:
+			return progress
+		# Check if PrintTimeGenius plugin is installed and enabled
+		print_time_genius_plugin = self._plugin_manager.plugins.get("PrintTimeGenius")
+		if print_time_genius_plugin is not None and print_time_genius_plugin.enabled and time_left > 0:
+			return print_time / (print_time + time_left) * 100
+		return progress
+

octoprint_octopod/job_notifications.py

@@ -10,7 +10,9 @@ def __init__(self, logger, ifttt_alerts, plugin_manager):
 		BaseNotification.__init__(self, logger, plugin_manager)
 		self._ifttt_alerts = ifttt_alerts
 
-	def on_print_progress(self, settings, progress):
+	def on_print_progress(self, settings, progress, printer):
+		(completion, print_time_in_seconds, print_time_left_in_seconds) = self._get_progress_data(printer, progress)
+		progress = round(completion) if completion is not None else progress
 		progress_type = settings.get(["progress_type"])
 		if progress_type == '0':
 			# Print notification disabled
@@ -60,13 +62,9 @@ def send_print_job_notification(self, settings, printer, event_payload, server_u
 		url = url + '/v1/push_printer'
 
 		# Gather information about progress completion of the job
-		completion = None
 		was_printing = False
 		current_data = printer.get_current_data()
-		if "progress" in current_data and current_data["progress"] is not None \
-				and "completion" in current_data["progress"] and current_data["progress"][
-			"completion"] is not None:
-			completion = current_data["progress"]["completion"]
+		(completion, print_time_in_seconds, print_time_left_in_seconds) = self._get_progress_data(printer)
 
 		current_printer_state_id = event_payload["state_id"]
 		if not test:

octoprint_octopod/live_activities.py

@@ -136,14 +136,10 @@ def __get_service_url(self, settings):
 
 	def __get_notification_data(self, settings, printer):
 		url = self.__get_service_url(settings)
-		completion = None
-		print_time_left_in_seconds = None
 		current_data = printer.get_current_data()
 		printer_status = None
-		if "progress" in current_data and current_data["progress"] is not None \
-				and "completion" in current_data["progress"] and current_data["progress"]["completion"] is not None:
-			completion = round(current_data["progress"]["completion"])
-			print_time_left_in_seconds = current_data["progress"]["printTimeLeft"]
+		(completion, print_time_in_seconds, print_time_left_in_seconds) = self._get_progress_data(printer)
+		completion = round(completion) if completion is not None else None
 
 		if "state" in current_data and current_data["state"] is not None:
 			printer_status = current_data["state"]["text"]