Multi-Tool/Multi-Material support

README.md

@@ -40,6 +40,8 @@ If you like it, I would be thankful about a cup of coffee :)
 - [X] Filter spool table
 - [X] Table column visibility
 - [X] Scan QR/Barcodes of a spool
+- [X] Multi Tool support
+- [X] Support for manual mid-print filament change
 
 ## Planning / next features
 - [ ] External Database (IN PROGRESS)

octoprint_SpoolManager/__init__.py

@@ -50,7 +50,7 @@ def initialize(self):
 
 		self._lastPrintState = None
 
-		self.metaDataFilamentLength = None
+		self.metaDataFilamentLengths = []
 
 		self.alreadyCanceled = False
 
@@ -60,82 +60,91 @@ def initialize(self):
 
 	################################################################################################### public functions
 
-	def checkRemainingFilament(self):
-
+	def checkRemainingFilament(self, onlyToolIndex=None):
 		shouldWarn = self._settings.get_boolean([SettingsKeys.SETTINGS_KEY_WARN_IF_FILAMENT_NOT_ENOUGH])
-		if (shouldWarn == False):
+		if not shouldWarn:
 			return True
 
 		# - check, if spool change in pause-mode
 
 		# - check if new spool fits for current printjob
-		selectedSpool = self.loadSelectedSpool()
-
-		if (selectedSpool == None or self.metaDataFilamentLength == None):
-			return False
-
-		# need attributes present: diameter, density, totalWeight
-		warningMessage = "Following fields not set in Spool '" + selectedSpool.displayName + "': "
-		missing = False
-
-		diameter = selectedSpool.diameter
-		density = selectedSpool.density
-		totalWeight = selectedSpool.totalWeight
-		usedWeight = selectedSpool.usedWeight
-		if (diameter == None):
-			missing = True
-			warningMessage += "diameter "
-		if (density == None):
-			missing = True
-			warningMessage += "density "
-		if (totalWeight == None):
-			missing = True
-			warningMessage += "total weight"
-		if (usedWeight == None):
-			usedWeight = 0.0
-
-		if (missing == True):
-			self._sendMessageToClient("warning", "Filament prediction not possible!", warningMessage)
-			return False
-
-		warningMessage = "One of the needed fields are not a number in Spool '" + selectedSpool.displayName + "': "
-		notANumber = False
-		try:
-			diameter = float(diameter)
-		except ValueError:
-			notANumber = True
-			warningMessage += "diameter "
-		try:
-			density = float(density)
-		except ValueError:
-			notANumber = True
-			warningMessage += "density "
-		try:
-			totalWeight = float(totalWeight)
-		except ValueError:
-			notANumber = True
-			warningMessage += "total weight "
-		try:
-			usedWeight = float(usedWeight)
-		except ValueError:
-			notANumber = True
-			warningMessage += "used weight "
-
-		if (notANumber == True):
-			self._sendMessageToClient("warning", "Filament prediction not possible!", warningMessage)
-			return False
-
-		# Benötigtes Gewicht = gewicht(geplante länge, durchmesser, dichte)
-		requiredWeight = int(self._calculateWeight(self.metaDataFilamentLength, diameter, density))
-
-		# Vorhanden Gewicht = Gesamtgewicht - Verbrauchtes Gewicht
-		remainingWeight = totalWeight - usedWeight
-
-		if (remainingWeight < requiredWeight):
-			self._sendMessageToClient("warning", "Filament not enough!",
-									  "Required '" + str(requiredWeight) + "g' available from Spool '" + str(remainingWeight) + "g'!")
-			return False
-		return True
+		selectedSpools = self.loadSelectedSpools()
+
+		result = True
+
+		for toolIndex, filamentLength in enumerate(self.metaDataFilamentLengths):
+			if onlyToolIndex is not None and onlyToolIndex != toolIndex:
+				continue
+			selectedSpool = selectedSpools[toolIndex] if toolIndex < len(selectedSpools) else None
+
+			if selectedSpool is None:
+				continue
+
+			diameter = selectedSpool.diameter
+			density = selectedSpool.density
+			totalWeight = selectedSpool.totalWeight
+			usedWeight = selectedSpool.usedWeight
+
+			# need attributes present: diameter, density, totalWeight
+			missing_fields = []
+			if diameter is None:
+				missing_fields.append('diameter')
+			if diameter is None:
+				missing_fields.append('density')
+			if totalWeight is None:
+				missing_fields.append('total weight')
+			if usedWeight is None:
+				usedWeight = 0.0
+
+			if missing_fields:
+				self._sendMessageToClient(
+					"warning", "Filament prediction not possible!",
+					"Following fields not set in Spool '%s' (in tool %d): %s" % (selectedSpool.displayName, toolIndex, ', '.join(missing_fields))
+				)
+				result = False
+				continue
+
+			not_a_number_fields = []
+			try:
+				diameter = float(diameter)
+			except ValueError:
+				not_a_number_fields.append('diameter')
+			try:
+				density = float(density)
+			except ValueError:
+				not_a_number_fields.append('density')
+			try:
+				totalWeight = float(totalWeight)
+			except ValueError:
+				not_a_number_fields.append('totalweight')
+			try:
+				usedWeight = float(usedWeight)
+			except ValueError:
+				not_a_number_fields.append('used weight')
+
+			if not_a_number_fields:
+				self._sendMessageToClient(
+					"warning", "Filament prediction not possible!",
+					"One of the needed fields are not a number in Spool '%s' (in tool %d): %s" % (selectedSpool.displayName, toolIndex, ', '.join(not_a_number_fields))
+				)
+				result = False
+				continue
+
+			# Benötigtes Gewicht = gewicht(geplante länge, durchmesser, dichte)
+			requiredWeight = int(self._calculateWeight(filamentLength, diameter, density))
+
+			# Vorhanden Gewicht = Gesamtgewicht - Verbrauchtes Gewicht
+			remainingWeight = totalWeight - usedWeight
+
+			if remainingWeight < requiredWeight:
+				self._sendMessageToClient(
+					"warning", "Filament not enough!",
+				    "Required on tool %d: %dg, available from Spool '%s': '%dg'" % (toolIndex, requiredWeight, selectedSpool.displayName, remainingWeight)
+				)
+				result = False
+				continue
+
+		return result
 
 
 	################################################################################################## private functions
@@ -282,62 +291,76 @@ def _on_printJobStarted(self):
 		# starting new print
 		self._filamentOdometer.reset()
 
-		spoolModel = self.loadSelectedSpool()
-		if (spoolModel != None):
-			if (StringUtils.isEmpty(spoolModel.firstUse) == True):
-				firstUse = datetime.now()
-				spoolModel.firstUse = firstUse
-				self._databaseManager.saveSpool(spoolModel)
-				self._sendDataToClient(dict(
-											action="reloadTable"
-											))
-		pass
+		reloadTable = False
+		selectedSpools = self.loadSelectedSpools()
+		for toolIndex, filamentLength in enumerate(self.metaDataFilamentLengths):
+			spoolModel = selectedSpools[toolIndex] if toolIndex < len(selectedSpools) else None
+			if (spoolModel != None):
+				if (StringUtils.isEmpty(spoolModel.firstUse) == True):
+					firstUse = datetime.now()
+					spoolModel.firstUse = firstUse
+					self._databaseManager.saveSpool(spoolModel)
+					reloadTable = True
+		if reloadTable:
+			self._sendDataToClient(dict(
+										action="reloadTable"
+										))
+
+	def commitOdometerData(self):
+		reload = False
+		selectedSpools = self.loadSelectedSpools()
+		for toolIndex, spoolModel in enumerate(selectedSpools):
+			if spoolModel is None:
+				self._logger.warning("Tool %d: No spool selected, could not update values after print" % toolIndex)
+				continue
+
+			# - Last usage datetime
+			lastUsage = datetime.now()
+			spoolModel.lastUse = lastUsage
+			# - Used length
+			try:
+				currentExtrusionLenght = self._filamentOdometer.get_extrusion('Tool%d' % toolIndex)
+			except KeyError:
+				self._logger.info("Tool %d: No filament extruded" % toolIndex)
+				continue
+			self._logger.info("Tool %d: Extruded filament length: %s" % (toolIndex, str(currentExtrusionLenght)))
+			spoolUsedLength = 0.0 if StringUtils.isEmpty(spoolModel.usedLength) == True else spoolModel.usedLength
+			self._logger.info("Tool %d: Current Spool filament length: %s" % (toolIndex, str(spoolUsedLength)))
+			newUsedLength = spoolUsedLength + currentExtrusionLenght
+			self._logger.info("Tool %d: New Spool filament length: %s" % (toolIndex, str(newUsedLength)))
+			spoolModel.usedLength = newUsedLength
+			# - Used weight
+			diameter = spoolModel.diameter
+			density = spoolModel.density
+			if diameter is None or density is None:
+				self._logger.warning(
+					"Tool %d: Could not update spool weight, because diameter or density not set in spool '%s'" % (toolIndex, spoolModel.displayName)
+				)
+			else:
+				usedWeight = self._calculateWeight(currentExtrusionLenght, diameter, density)
+				spoolUsedWeight = 0.0 if spoolModel.usedWeight == None else spoolModel.usedWeight
+				newUsedWeight = spoolUsedWeight + usedWeight
+				spoolModel.usedWeight = newUsedWeight
 
-	#### print job finished
-	def _on_printJobFinished(self, printStatus, payload):
+			self._databaseManager.saveSpool(spoolModel)
+			reload = True
 
-		spoolModel = self.loadSelectedSpool()
-		if (spoolModel == None):
-			self._logger.warning("No spool selected, could not update values after print")
-			return
+		self._filamentOdometer.reset_extruded_length()
 
-		# - Last usage datetime
-		lastUsage = datetime.now()
-		spoolModel.lastUse = lastUsage
-		# - Used length
-		currentExtrusionForAllTools = self._filamentOdometer.getExtrusionForAllTools()
-		# if (len(currentExtrusionForAllTools) == 0):
-		# 	self._logger.warning("Odomenter could not detect any extrusion")
-		# 	return
-		currentExtrusionLenght = currentExtrusionForAllTools # TODO Support of multi-tool
-		self._logger.info("Extruded filament length: " + str(currentExtrusionLenght))
-		spoolUsedLength = 0.0 if StringUtils.isEmpty(spoolModel.usedLength) == True else spoolModel.usedLength
-		self._logger.info("Current Spool filament length: " + str(spoolUsedLength))
-		newUsedLength = spoolUsedLength + currentExtrusionLenght
-		self._logger.info("New Spool filament length: " + str(newUsedLength))
-		spoolModel.usedLength = newUsedLength
-		# - Used weight
-		diameter = spoolModel.diameter
-		density = spoolModel.density
-		if (diameter == None or  density == None):
-			self._logger.warning("Could not update spool weight, because diameter or density not set in spool '"+spoolModel.displayName+"'")
-		else:
-			usedWeight = self._calculateWeight(currentExtrusionLenght, diameter, density)
-			spoolUsedWeight = 0.0 if spoolModel.usedWeight == None else spoolModel.usedWeight
-			newUsedWeight = spoolUsedWeight + usedWeight
-			spoolModel.usedWeight = newUsedWeight
-
-		self._databaseManager.saveSpool(spoolModel)
-		self._sendDataToClient(dict(
-									action = "reloadTable and sidebarSpools"
-									))
-		pass
+		if reload:
+			self._sendDataToClient(dict(
+				action="reloadTable and sidebarSpools"
+			))
+
+	#### print job finished
+	def _on_printJobFinished(self, printStatus, payload):
+		self.commitOdometerData()
 
 	def _on_clientOpened(self, payload):
 		# start-workaround https://github.com/foosel/OctoPrint/issues/3400
 		import time
 		time.sleep(3)
-		selectedSpoolAsDict = None
+		selectedSpoolsAsDicts = []
 
 		# Check if database is available
 		# connected = self._databaseManager.reConnectToDatabase()
@@ -360,16 +383,14 @@ def _on_clientOpened(self, payload):
 		# Send plugin storage information
 		## Storage
 		if (connectionErrorResult == None):
-			selectedSpool = self.loadSelectedSpool()
-			if (selectedSpool):
-				selectedSpoolAsDict = Transformer.transformSpoolModelToDict(selectedSpool)
-			else:
-				# spool not found
-				pass
+			selectedSpoolsAsDicts = [
+				(None if selectedSpool is None else Transformer.transformSpoolModelToDict(selectedSpool))
+				for selectedSpool in self.loadSelectedSpools()
+			]
 
 		pluginNotWorking = connectionErrorResult != None
 		self._sendDataToClient(dict(action = "initalData",
-									selectedSpool = selectedSpoolAsDict,
+									selectedSpools = selectedSpoolsAsDicts,
 									isFilamentManagerPluginAvailable = self._filamentManagerPluginImplementation != None,
 									pluginNotWorking = pluginNotWorking
 									))
@@ -380,21 +401,18 @@ def _on_clientClosed(self, payload):
 		self.databaseConnectionProblemConfirmed = False
 
 	def _on_file_selectionChanged(self, payload):
+		self.metaDataFilamentLengths = []
+
 		if ("origin" in payload and "path" in payload):
 			metadata = self._file_manager.get_metadata(payload["origin"], payload["path"])
 			if ("analysis" in metadata):
 				if ("filament" in metadata["analysis"]):
-					allFilemants = metadata["analysis"]["filament"]
-					# TODO support multiple tools and not only tool0 (or first you got)
-					if (allFilemants):
-						for toolIndex in range(5):
-							toolName = "tool" + str(toolIndex)
-							if (toolName in allFilemants):
-								self.metaDataFilamentLength = allFilemants[toolName]["length"]
-								self.checkRemainingFilament()
-						return
-
-		self.metaDataFilamentLength = 0.0
+					for toolName, toolData in metadata["analysis"]["filament"].items():
+						toolIndex = int(toolName[4:])
+						self.metaDataFilamentLengths += [0.0] * (toolIndex + 1 - len(self.metaDataFilamentLengths))
+						self.metaDataFilamentLengths[toolIndex] = toolData["length"]
+
+		self.checkRemainingFilament()
 
 	pass
 	######################################################################################### Hooks and public functions
@@ -489,6 +507,7 @@ def get_settings_defaults(self):
 
 		# Not visible
 		settings[SettingsKeys.SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID] = None
+		settings[SettingsKeys.SETTINGS_KEY_SELECTED_SPOOLS_DATABASE_IDS] = []
 		settings[SettingsKeys.SETTINGS_KEY_HIDE_EMPTY_SPOOL_IN_SIDEBAR] = False
 		settings[SettingsKeys.SETTINGS_KEY_HIDE_INACTIVE_SPOOL_IN_SIDEBAR] = True
 		## Genral