New Version 1.7.0rc1

- E #246 EventBus-Events to support MQTT-Topics
- E #186 multiple templates (with field selection)
- E #191 Include PTFE tube length for remaining check
- E #221 Preview of QR-Code
- E #207 Define IP/URL for QR-Code generation
- E #220 Output of database id in QR-Code view
- E #236, B #228 Output of total spools in tab-view
- E Output of database id in QR-Code and in table

- B #245 Show last weight digit
- B #235 custom colorname not stored
- B #225 copy was disabled during printing

Author: OllisGit

README.md

@@ -85,6 +85,63 @@ At the meantime you need to uninstall and install the version you like from the
 
 see [Release-Overview](https://github.com/OllisGit/OctoPrint-SpoolManager/releases/)
 
+
+---
+# Developer - Section
+
+## Events
+Plugin sends the following custom events to the eventbus like this:
+
+    eventManager().fire(eventKey, eventPayload)
+
+| EventKeys                             |
+| ------------------------------------ |
+| plugin_spoolmanager_spool_weight_updated_after_print |
+| plugin_spoolmanager_spool_selected |
+| plugin_spoolmanager_spool_deselected |
+| plugin_spoolmanager_spool_added |
+| plugin_spoolmanager_spool_deleted |
+
+HINT: In combination with the [MQTT Plugin](https://github.com/OctoPrint/OctoPrint-MQTT) you can subscribe e.g. to this topic:
+```
+octoPrint/event/plugin_spoolmanager_spool_deselected
+```
+
+
+**Payload**
+
+_spool_added_, _spool_selected_
+```javascript
+ {
+   'databaseId': 23,
+   'toolId': 1,
+   'spoolName':'Fancy Spool',
+   'material':'ABS',
+   'colorName':'dark red',
+   'remainingWeight': 1234
+ }
+```
+_spool_deselected_
+```javascript
+ {
+   'toolId': 1
+ }
+```
+_spool_deleted_
+```javascript
+ {
+   'databaseId': 23
+ }
+```
+Other Plugins could listen to this events in there python-code like this:
+
+    eventmanager.subscribe("plugin_spoolmanager_spool_selected", self._myEventListener)
+
+or use `octoprint.plugin.EventHandlerPlugin` with something like this:
+
+    def on_event(self, event, payload):
+        if event == "plugin_spoolmanager_spool_selected":
+            ## do something usefull
 ---
 
 ### Used UI-Tools

octoprint_SpoolManager/DatabaseManager.py

@@ -872,6 +872,13 @@ def loadDatabaseMetaInformations(self, databaseSettings = None):
 			"externalSpoolItemCount": externalSpoolItemCount
 		}
 
+	def loadFirstSingleSpool(self, withReusedConnection=False):
+		def databaseCallMethode():
+			return SpoolModel.select().limit(1)[0]
+
+		return self._handleReusableConnection(databaseCallMethode, withReusedConnection, "loadFirstSingleSpool")
+
+
 	def loadSpool(self, databaseId, withReusedConnection=False):
 		def databaseCallMethode():
 			return SpoolModel.get_or_none(databaseId)

octoprint_SpoolManager/__init__.py

@@ -11,12 +11,14 @@
 
 from octoprint_SpoolManager.DatabaseManager import DatabaseManager
 # from octoprint_SpoolManager.Odometer import FilamentOdometer
+
 from octoprint_SpoolManager.newodometer import NewFilamentOdometer
 
 from octoprint_SpoolManager.api import Transformer
 from octoprint_SpoolManager.api.SpoolManagerAPI import SpoolManagerAPI
 from octoprint_SpoolManager.common import StringUtils
 from octoprint_SpoolManager.common.SettingsKeys import SettingsKeys
+from octoprint_SpoolManager.common.EventBusKeys import EventBusKeys
 
 class SpoolmanagerPlugin(
 							SpoolManagerAPI,
@@ -62,7 +64,6 @@ def initialize(self):
 		self._logger.info("Done initializing")
 		pass
 
-
 	################################################################################################### public functions
 
 	def checkRemainingFilament(self, forToolIndex=None):
@@ -134,6 +135,12 @@ def _sendMessageToClient(self, type, title, message, autoclose=False):
 									message=message,
 									autoclose=autoclose))
 
+	def _sendPayload2EventBus(self, eventKey, eventPayload):
+
+		eventName = "plugin_spoolmanager_" + eventKey
+		self._logger.info("Send Event '"+eventName+"' with payload '"+str(eventPayload)+"' to event-bus")
+		self._event_bus.fire(eventName, payload=eventPayload)
+
 	def _checkForMissingPluginInfos(self, sendToClient=False):
 
 		pluginInfo = self._getPluginInformation("filamentmanager")
@@ -275,14 +282,23 @@ def _evaluateRequiredWeight(self, selectedSpools, forToolIndex=None, warnUser=Fa
 						someAttributesMissing = True
 					else:
 						# Benötigtes Gewicht = gewicht(geplante länge, durchmesser, dichte)
-						requiredWeight = int(self._calculateWeight(filamentLength, diameter, density))
+						requiredWeight = self._calculateWeight(filamentLength, diameter, density)
 
 						# Vorhanden Gewicht = Gesamtgewicht - Verbrauchtes Gewicht
 						# TODO don't calculate here use the value from the database
 						remainingWeight = totalWeight - usedWeight
 
+						saftyLengthInMM = self._settings.get_int([SettingsKeys.SETTINGS_KEY_SAFETY_LENGTH])
+						if (saftyLengthInMM != 0):
+							saftyRequiredWeight = self._calculateWeight(saftyLengthInMM, diameter, density)
+							self._logger.info("saftyWeight '" + str(saftyRequiredWeight) + "' from saftyLengthInMM '" + str(saftyLengthInMM) + "' calculated")
+							requiredWeight = requiredWeight + saftyRequiredWeight
+
+						self._logger.info("tool" + str(toolIndex) + ", requiredWeight '" + str(requiredWeight) + "',  remainingWeight '" + str(remainingWeight) + "'")
+
 						notEnough = False
 						if remainingWeight < requiredWeight and requiredWeight > 0:
+							self._logger.info("Filament not enough!")
 							if (warnUser == True):
 								self._sendMessageToClient(
 									"warning", "Filament not enough!",
@@ -425,6 +441,7 @@ def _on_printJobStarted(self):
 										action="reloadTable"
 										))
 	# assign the current extrusion to the current selected spools
+
 	def commitOdometerData(self):
 		reload = False
 		selectedSpools = self.loadSelectedSpools()
@@ -465,6 +482,17 @@ def commitOdometerData(self):
 				self._logger.info("Tool %d: New spoolUsedWeight: %s" % (toolIndex, str(newUsedWeight)))
 
 			self._databaseManager.saveSpool(spoolModel)
+
+			eventPayload = {
+				"toolId": toolIndex,
+				"databaseId": spoolModel.databaseId,
+				"spoolName": spoolModel.displayName,
+				"material": spoolModel.material,
+				"colorName": spoolModel.colorName,
+				"remainingWeight": spoolModel.remainingWeight
+			}
+			self._sendPayload2EventBus(EventBusKeys.EVENT_BUS_SPOOL_WEIGHT_UPDATED_AFTER_PRINT, eventPayload)
+
 			reload = True
 
 		self.myFilamentOdometer.reset_extruded_length()
@@ -597,6 +625,13 @@ def on_sentGCodeHook(self, comm_instance, phase, cmd, cmd_type, gcode, *args, **
 
 	def on_event(self, event, payload):
 
+		# if (event != "RegisteredMessageReceived"):
+		# 	print("*** EVENT: " + event)
+		#
+		# if ("plugin_spoolmanager" in event):
+		# 	print(payload)
+		# 	pass
+
 		if (Events.CLIENT_OPENED == event):
 			self._on_clientOpened(payload)
 			return
@@ -714,11 +749,14 @@ def get_settings_defaults(self):
 		settings[SettingsKeys.SETTINGS_KEY_WARN_IF_SPOOL_NOT_SELECTED] = True
 		settings[SettingsKeys.SETTINGS_KEY_WARN_IF_FILAMENT_NOT_ENOUGH] = True
 		settings[SettingsKeys.SETTINGS_KEY_CURRENCY_SYMBOL] = "€"
+		settings[SettingsKeys.SETTINGS_KEY_SAFETY_LENGTH] = 0
 
 		## QR-Code
 		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_ENABLED] = True
-		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_FILL_COLOR] = "darkgreen"
-		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_BACKGROUND_COLOR] = "white"
+		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_USE_URL_PREFIX] = False
+		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_URL_PREFIX] = None
+		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_FILL_COLOR] = "#008000"
+		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_BACKGROUND_COLOR] = "#ffffff"
 		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_WIDTH] = "100"
 		settings[SettingsKeys.SETTINGS_KEY_QR_CODE_HEIGHT] = "100"
 
@@ -756,6 +794,7 @@ def get_settings_defaults(self):
 		# 	"password": "illO"
 		# }
 
+		settings["excludedFromTemplateCopy"] = []
 		return settings
 
 	##~~ TemplatePlugin mixin
@@ -838,12 +877,13 @@ def get_update_information(self):
 			)
 		)
 
-
-
-
-
-
-
+	def register_custom_events(*args, **kwargs):
+		return [EventBusKeys.EVENT_BUS_SPOOL_WEIGHT_UPDATED_AFTER_PRINT,
+				EventBusKeys.EVENT_BUS_SPOOL_SELECTED,
+				EventBusKeys.EVENT_BUS_SPOOL_DESELECTED,
+				EventBusKeys.EVENT_BUS_SPOOL_ADDED,
+				EventBusKeys.EVENT_BUS_SPOOL_DELETED
+				]
 
 
 
@@ -870,7 +910,8 @@ def __plugin_load__():
 	global __plugin_hooks__
 	__plugin_hooks__ = {
 		"octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information,
-		"octoprint.comm.protocol.gcode.sent": __plugin_implementation__.on_sentGCodeHook
+		"octoprint.comm.protocol.gcode.sent": __plugin_implementation__.on_sentGCodeHook,
 		# "octoprint.comm.protocol.scripts": __plugin_implementation__.message_on_connect
+		"octoprint.events.register_custom_events":  __plugin_implementation__.register_custom_events
 	}