RC3

- #13 more logging
- #12 always verify spool before print
- #11 show remaining filament in spool selection
- #10 display of orange
- #9 remaining filament not shown

README.md

@@ -38,6 +38,7 @@ should include the following features:
 
 ## Planning Release #2
 
+- [ ] External Database
 - [ ] Table column visibity
 - [ ] Capture Spool-Image
 - [ ] Scan QR/Barcodes of a spool

octoprint_SpoolManager/__init__.py

@@ -282,7 +282,6 @@ def _on_clientOpened(self, payload):
 			selectedSpoolAsDict = Transformer.transformSpoolModelToDict(selectedSpool)
 		else:
 			# spool not found
-			self._logger.warning("Last selected Spool from plugin-settings not found in database. Maybe deleted in the meantime.")
 			pass
 
 		self._sendDataToClient(dict(action="initalData",
@@ -367,6 +366,7 @@ def get_settings_defaults(self):
 
 		## Genral
 		settings[SettingsKeys.SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID] = None
+		settings[SettingsKeys.SETTINGS_KEY_REMINDER_SELECTING_SPOOL] = True
 		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] = "€"

octoprint_SpoolManager/api/SpoolManagerAPI.py

@@ -99,9 +99,26 @@ def loadSelectedSpool(self):
 		databaseId = self._settings.get_int([SettingsKeys.SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID])
 		if (databaseId != None):
 			spoolModel = self._databaseManager.loadSpool(databaseId)
+			if (spoolModel == None):
+				self._logger.warning(
+					"Last selected Spool from plugin-settings not found in database. Maybe deleted in the meantime.")
 
 		return spoolModel
 
+
+	def _createSampleSpoolModel(self):
+		#DisplayName, Vendor, Material, Color[# code], Diameter [mm], Density [g/cm³], Temperature [°C], TotalWeight [g], UsedWeight [g], UsedLength [mm], FirstUse [dd.mm.yyyy hh:mm], LastUse [dd.mm.yyyy hh:mm], PurchasedFrom, PurchasedOn [dd.mm.yyyy hh:mm], Cost, CostUnit, Labels, NoteText
+
+		s1 = SpoolModel()
+		s1.displayName = "Number #1"
+		s1.vendor = "The Spool Company"
+		s1.material = "PETG"
+		s1.color = "#FF0000"
+		s1.diameter = 1.75
+		s1.density = 1.27
+		return s1
+
+
 	################################################### APIs
 
 	##############################################################################################   ALLOWED TO PRINT
@@ -110,6 +127,7 @@ def allowed_to_print(self):
 
 		checkForSelectedSpool = self._settings.get_boolean([SettingsKeys.SETTINGS_KEY_WARN_IF_SPOOL_NOT_SELECTED])
 		checkForFilamentLength = self._settings.get_boolean([SettingsKeys.SETTINGS_KEY_WARN_IF_FILAMENT_NOT_ENOUGH])
+		reminderSelectingSpool = self._settings.get_boolean([SettingsKeys.SETTINGS_KEY_REMINDER_SELECTING_SPOOL])
 
 		if (checkForFilamentLength == False and checkForSelectedSpool == False):
 			return flask.jsonify({
@@ -123,18 +141,24 @@ def allowed_to_print(self):
 				"result": "noSpoolSelected",
 			})
 
-		if (checkForFilamentLength == True):
-			# check if loaded
-			if (spoolModel == None):
+		if (checkForFilamentLength == True and spoolModel != None):
+			# # check if loaded
+			# if (spoolModel == None):
+			# 	return flask.jsonify({
+			# 		"result": "noSpoolForUsageCheck",
+			# 	})
+			# else:
+			result = self.checkRemainingFilament();
+			if (result == False):
 				return flask.jsonify({
-					"result": "noSpoolForUsageCheck",
+					"result": "filamentNotEnough",
 				})
-			else:
-				result = self.checkRemainingFilament();
-				if (result == False):
-					return flask.jsonify({
-						"result": "filamentNotEnough",
-					})
+
+		if (reminderSelectingSpool == True and spoolModel != None):
+			return flask.jsonify({
+				"result": "reminderSpoolSelection",
+				"spoolName": spoolModel.displayName
+			})
 
 		return flask.jsonify({
 			"result": "startPrint"
@@ -143,20 +167,26 @@ def allowed_to_print(self):
 	#####################################################################################################   SELECT SPOOL
 	@octoprint.plugin.BlueprintPlugin.route("/selectSpool", methods=["PUT"])
 	def select_spool(self):
+		self._logger.info("API Store selected spool")
 		jsonData = request.json
 
 		databaseId = self._getValueFromJSONOrNone("databaseId", jsonData)
 		if (databaseId != None):
 			spoolModel = self._databaseManager.loadSpool(databaseId)
 			# check if loaded
 			if (spoolModel != None):
+				self._logger.info("Store selected spool '"+spoolModel.displayName+"' in settings.")
+
 				# - store spool in Settings
 				self._settings.set_int([SettingsKeys.SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID], databaseId)
 				self._settings.save()
 
 				self.checkRemainingFilament()
+			else:
+				self._logger.warning("Selected Spool with id '"+str(databaseId)+"' not in database anymore. Maybe deleted in the meantime.")
 		else:
 			# No selection
+			self._logger.info("Clear stored selected spool in settings.")
 			self._settings.set_int([SettingsKeys.SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID], None)
 			self._settings.save()
 			pass
@@ -169,7 +199,7 @@ def select_spool(self):
 	##################################################################################################   LOAD ALL SPOOLS
 	@octoprint.plugin.BlueprintPlugin.route("/loadSpoolsByQuery", methods=["GET"])
 	def load_allSpools(self):
-
+		self._logger.debug("API Load all spool")
 		# sp1 = SpoolModel()
 		# sp1.displayName = "Spool No.1"
 		# sp1.vendor = "Janbex"
@@ -237,13 +267,16 @@ def load_allSpools(self):
 	#######################################################################################################   SAVE SPOOL
 	@octoprint.plugin.BlueprintPlugin.route("/saveSpool", methods=["PUT"])
 	def save_spool(self):
+		self._logger.info("API Save spool")
 		jsonData = request.json
 
 		databaseId = self._getValueFromJSONOrNone("databaseId", jsonData)
 		if (databaseId != None):
+			self._logger.info("Update spool with database id '"+str(databaseId)+"'")
 			spoolModel = self._databaseManager.loadSpool(databaseId)
 			self._updateSpoolModelFromJSONData(spoolModel, jsonData)
 		else:
+			self._logger.info("Create new spool")
 			spoolModel = SpoolModel()
 			self._updateSpoolModelFromJSONData(spoolModel, jsonData)
 
@@ -255,6 +288,7 @@ def save_spool(self):
 	#####################################################################################################   DELETE SPOOL
 	@octoprint.plugin.BlueprintPlugin.route("/deleteSpool/<int:databaseId>", methods=["DELETE"])
 	def delete_printjob(self, databaseId):
+		self._logger.info("API Delete spool with database id '" + str(databaseId) + "'")
 		printJob = self._databaseManager.deleteSpool(databaseId)
 		# snapshotFilename = CameraManager.buildSnapshotFilename(printJob.printStartDateTime)
 		# self._cameraManager.deleteSnapshot(snapshotFilename)

octoprint_SpoolManager/api/Transformer.py

@@ -4,6 +4,29 @@
 from octoprint_SpoolManager.models.SpoolModel import SpoolModel
 from octoprint_SpoolManager.common import StringUtils
 
+def _calculateRemainingWeight(usedWeight, totalWeight):
+	if (usedWeight == None or totalWeight == None):
+		return None
+
+	if ( (type(usedWeight) == int or type(usedWeight) == float) and
+			(type(totalWeight) == int or type(totalWeight) == float) ):
+		result = totalWeight - usedWeight
+		return result
+
+	return None
+
+def _calculateUsedPercentage(remainingWeight, totalWeight):
+	if (remainingWeight == None or totalWeight == None):
+		return None
+
+	if ( (type(remainingWeight) == int or type(remainingWeight) == float) and
+			(type(totalWeight) == int or type(totalWeight) == float) ):
+		result = remainingWeight / (totalWeight / 100.0);
+		return result
+
+	return None
+
+
 def transformSpoolModelToDict(spoolModel):
 	spoolAsDict = spoolModel.__data__
 
@@ -14,10 +37,24 @@ def transformSpoolModelToDict(spoolModel):
 
 	spoolAsDict["created"] = StringUtils.formatDateTime(spoolModel.created)
 
-	# Decimal and date time needs to be converted
+
+	totalWeight = spoolModel.totalWeight
+	usedWeight = spoolModel.usedWeight
+	remainingWeight = _calculateRemainingWeight(usedWeight, totalWeight)
+	usedPercentage = _calculateUsedPercentage(remainingWeight, totalWeight)
+
+	spoolAsDict["remainingWeight"] = StringUtils.formatFloat(remainingWeight)
+	spoolAsDict["usedPercentage"] = StringUtils.formatFloat(usedPercentage)
+
+
+	# Decimal and date time needs to be converted. ATTENTION orgiginal fields will be modified
 	spoolAsDict["totalWeight"] = StringUtils.formatFloat(spoolModel.totalWeight)
 	spoolAsDict["usedWeight"] = StringUtils.formatFloat(spoolModel.usedWeight)
 
+
+
+
+
 	# spoolAsDict["temperature"] = StringUtils.formatSave("{:.02f}", spoolAsDict["temperature"], "")
 	# spoolAsDict["weight"] = StringUtils.formatSave("{:.02f}", spoolAsDict["weight"], "")
 	# spoolAsDict["remainingWeight"] = StringUtils.formatSave("{:.02f}", spoolAsDict["remainingWeight"], "")

octoprint_SpoolManager/common/SettingsKeys.py

@@ -5,6 +5,7 @@ class SettingsKeys():
 
 	SETTINGS_KEY_SELECTED_SPOOL_DATABASE_ID = "selectedSpoolDatabaseId"
 
+	SETTINGS_KEY_REMINDER_SELECTING_SPOOL = "reminderSelectingSpool"
 	SETTINGS_KEY_WARN_IF_SPOOL_NOT_SELECTED = "warnIfSpoolNotSelected"
 	SETTINGS_KEY_WARN_IF_FILAMENT_NOT_ENOUGH = "warnIfFilamentNotEnough"
 

octoprint_SpoolManager/static/css/SpoolManager.css

@@ -31,12 +31,12 @@
             overflow: hidden;
             text-overflow: ellipsis;
         }
-
-        .dropdown-menu {
-            max-height: 120px;
-            overflow-y: auto;
-            overflow-x: hidden;
-        }
+// TODO Maybe not needed any more
+//        .dropdown-menu {
+//            max-height: 120px;
+//            overflow-y: auto;
+//            overflow-x: hidden;
+//        }
 
 
 

octoprint_SpoolManager/static/js/ComponentFactory.js

@@ -203,13 +203,13 @@ function ComponentFactory(pluginId) {
             showHexInput          : true,
             allowBlank            : false,
             basicColors           : {
-                  white     : 'fff',
-                  black     : '000',
-                  red       : 'f00',
+                  white     : 'ffffff',
+                  black     : '000000',
+                  red       : 'ff0000',
                   green     : '008000',
-                  blue      : '00f',
-                  yellow    : 'ff0',
-                  orange    : 'f60',
+                  blue      : '0000ff',
+                  yellow    : 'ffff00',
+                  orange    : 'ffa500',
                   purple    : '800080',
 //                  gray      : '808080',
 //                  darkgray  : 'A9A9A9',

octoprint_SpoolManager/static/js/SpoolManager-EditSpoolDialog.js

@@ -169,9 +169,9 @@ function SpoolManagerEditSpoolDialog(){
         this.color(updateData.color == null ? DEFAULT_COLOR : updateData.color);
         this.temperature(updateData.temperature);
         this.totalWeight(updateData.totalWeight);
-//        this.remainingWeight(updateData.remainingWeight);
+        this.remainingWeight(updateData.remainingWeight);
         this.code(updateData.code);
-//        this.usedPercentage(updateData.usedPercentage); // TODO needed?
+        this.usedPercentage(updateData.usedPercentage);
         this.usedLength(updateData.usedLength);
         this.usedWeight(updateData.usedWeight);
 
@@ -349,7 +349,7 @@ function SpoolManagerEditSpoolDialog(){
             self.updateUsedPercentage();
         });
 
-        // update used percentage
+        // update RemainingWeight
         self.updateRemainingWeight = function(){
             var total = self.spoolItemForEditing.totalWeight();
             var used = self.spoolItemForEditing.usedWeight();

octoprint_SpoolManager/static/js/SpoolManager.js

@@ -142,7 +142,14 @@ $(function() {
                 displayName = "   ";
             }
 
-            var label =  color + " - " + material + " - " + displayName;
+            var remainingFilament = spoolItem.remainingWeight;
+            if (remainingFilament && displayName.trim().length != 0){
+                remainingFilament = " (" + remainingFilament + "%)" ;
+            } else {
+                remainingFilament = "";
+            }
+
+            var label =  color + " - " + material + " - " + displayName + remainingFilament;
             return label
         }
 
@@ -239,15 +246,24 @@ $(function() {
                             }
                             return;
                         }
-                        if ("noSpoolForUsageCheck" == result){
-                            self.showPopUp("Error", "", "No Spool selected for usage check. Select a spool first");
-                            return
-                        }
+//                        Not needed because a length check is only done, if spool was selected
+//                        if ("noSpoolForUsageCheck" == result){
+//                            self.showPopUp("Error", "", "No Spool selected for usage check. Select a spool first");
+//                            return;
+//                        }
                         if ("filamentNotEnough" == result){
                             var check = confirm('Not enough filament. Do you want to start the print anyway?');
                             if (check == true) {
                                 startPrint();
                             }
+                            return;
+                        }
+                        if ("reminderSpoolSelection" == result){
+                            var question = "Please verify your selected Spool '"+responseData.spoolName+"'. Do you want to start the print anyway?";
+                            var check = confirm(question);
+                            if (check == true) {
+                                startPrint();
+                            }
                         }
                     }
                 });

octoprint_SpoolManager/templates/SpoolManager_settings.jinja2

@@ -14,6 +14,13 @@
             <!-- GENERAL - TAB -->
             <div class="tab-pane active" id="tab-spool-General">
 
+                <div class="control-group">
+                    <div class="controls">
+                        <label class="checkbox">
+                            <input type="checkbox" data-bind="checked: pluginSettings.reminderSelectingSpool" > Reminder for verifying the selected spool.
+                        </label>
+                    </div>
+                </div>
                 <div class="control-group">
                     <div class="controls">
                         <label class="checkbox">

octoprint_SpoolManager/templates/SpoolManager_tab_dialogs.jinja2

@@ -157,7 +157,7 @@
                                 </div>
                             </div>
                             <div class="control-group no-bottom-gap">
-                                <label class="control-label">Density <sup>2</sup></label>
+                                <label class="control-label">Density <sup>2,3</sup></label>
                                 <div class="controls">
                                     <div class="input-append">
                                         <input type="text" class="input-small text-right" data-bind="value: spoolDialog.spoolItemForEditing.density" />
@@ -238,8 +238,10 @@
 -->
                             <div class="control-group" style="margin-bottom: -20px;">
                                 <label class="">
-                                    <div><sup>1</sup><small>Mandatory field</small></label></div>
+                                    <div><sup>1</sup><small>Mandatory field</small></div>
                                     <div><sup>2</sup><small>Needed for filament usage prediction</small></div>
+                                    <div><sup>3</sup><small>See <a href="https://bitfab.io/blog/3d-printing-materials-densities/" target="newTab">https://bitfab.io/blog/3d-printing-materials-densities/ (without warranty)</a></small></div>
+                                 </label>
                             </div>
 
                         </div>
@@ -278,7 +280,7 @@
                                             <div class="input-append">
                                                 <input type="text" class="input-small text-right" data-bind="value: spoolDialog.spoolItemForEditing.cost"/>
 <!--                                                <input type="text" class="input-mini text-right" data-bind="value: spoolDialog.spoolItemForEditing.costUnit" />-->
-                                                <span class="add-on"data-bind="text: spoolDialog.spoolItemForEditing.costUnit" >€</span>
+                                                <span class="add-on" data-bind="text: spoolDialog.spoolItemForEditing.costUnit" >€</span>
                                             </div>
                                         </div>
                                     </div>