Store the Quality profile for the 'global' and extruders in the gcode. Read in all of the quality profile during import.

Contributes to CURA-1727 GCode Profile reading/writing: Broken and needs update

plugins/CuraProfileReader/CuraProfileReader.py

@@ -3,7 +3,6 @@
 
 import os.path
 
-from UM.Application import Application #To get the machine manager to create the new profile in.
 from UM.Logger import Logger
 from UM.Settings.InstanceContainer import InstanceContainer #The new profile to make.
 from cura.ProfileReader import ProfileReader

plugins/GCodeProfileReader/GCodeProfileReader.py

@@ -1,10 +1,9 @@
 # Copyright (c) 2015 Ultimaker B.V.
 # Cura is released under the terms of the AGPLv3 or higher.
 
-import os
 import re #Regular expressions for parsing escape characters in the settings.
+import json
 
-from UM.Application import Application #To get the machine manager to create the new profile in.
 from UM.Settings.InstanceContainer import InstanceContainer
 from UM.Logger import Logger
 from UM.i18n import i18nCatalog
@@ -22,7 +21,7 @@ class GCodeProfileReader(ProfileReader):
     #   It can only read settings with the same version as the version it was
     #   written with. If the file format is changed in a way that breaks reverse
     #   compatibility, increment this version number!
-    version = 2
+    version = 3
 
     ##  Dictionary that defines how characters are escaped when embedded in
     #   g-code.
@@ -66,21 +65,37 @@ class GCodeProfileReader(ProfileReader):
             Logger.log("e", "Unable to open file %s for reading: %s", file_name, str(e))
             return None
 
-        # Un-escape the serialized profile.
-        pattern = re.compile("|".join(GCodeProfileReader.escape_characters.keys()))
-
-        # Perform the replacement with a regular expression.
-        serialized = pattern.sub(lambda m: GCodeProfileReader.escape_characters[re.escape(m.group(0))], serialized)
+        serialized = unescapeGcodeComment(serialized)
         Logger.log("i", "Serialized the following from %s: %s" %(file_name, repr(serialized)))
 
-        # Create an empty profile - the id and name will be changed by the ContainerRegistry
-        profile = InstanceContainer("")
-        try:
-            profile.deserialize(serialized)
-        except Exception as e:  # Not a valid g-code file.
-            Logger.log("e", "Unable to serialise the profile: %s", str(e))
-            return None
+        json_data = json.loads(serialized)
 
-        profile.addMetaDataEntry("type", "quality")
+        profile_strings = [json_data["global_quality"]]
+        profile_strings.extend(json_data.get("extruder_quality", []))
 
-        return profile
+        return [readQualityProfileFromString(profile_string) for profile_string in profile_strings]
+
+##  Unescape a string which has been escaped for use in a gcode comment.
+#
+#   \param string The string to unescape.
+#   \return \type{str} The unscaped string.
+def unescapeGcodeComment(string):
+    # Un-escape the serialized profile.
+    pattern = re.compile("|".join(GCodeProfileReader.escape_characters.keys()))
+
+    # Perform the replacement with a regular expression.
+    return pattern.sub(lambda m: GCodeProfileReader.escape_characters[re.escape(m.group(0))], string)
+
+##  Read in a profile from a serialized string.
+#
+#   \param profile_string The profile data in serialized form.
+#   \return \type{Profile} the resulting Profile object or None if it could not be read.
+def readQualityProfileFromString(profile_string):
+    # Create an empty profile - the id and name will be changed by the ContainerRegistry
+    profile = InstanceContainer("")
+    try:
+        profile.deserialize(profile_string)
+    except Exception as e:  # Not a valid g-code file.
+        Logger.log("e", "Unable to serialise the profile: %s", str(e))
+        return None
+    return profile

plugins/GCodeWriter/GCodeWriter.py

@@ -4,8 +4,11 @@
 from UM.Mesh.MeshWriter import MeshWriter
 from UM.Logger import Logger
 from UM.Application import Application
-from UM.Settings.InstanceContainer import InstanceContainer #To create a complete setting profile to store in the g-code.
+
+from cura.Settings.ExtruderManager import ExtruderManager
+
 import re #For escaping characters in the settings.
+import json
 
 ##  Writes g-code to a file.
 #
@@ -23,7 +26,7 @@ class GCodeWriter(MeshWriter):
     #   It can only read settings with the same version as the version it was
     #   written with. If the file format is changed in a way that breaks reverse
     #   compatibility, increment this version number!
-    version = 2
+    version = 3
 
     ##  Dictionary that defines how characters are escaped when embedded in
     #   g-code.
@@ -64,25 +67,33 @@ class GCodeWriter(MeshWriter):
     #
     #   \param settings A container stack to serialise.
     #   \return A serialised string of the settings.
-    def _serialiseSettings(self, settings):
+    def _serialiseSettings(self, stack):
         prefix = ";SETTING_" + str(GCodeWriter.version) + " "  # The prefix to put before each line.
         prefix_length = len(prefix)
 
-        global_stack = Application.getInstance().getGlobalContainerStack()
-        container_with_profile = global_stack.findContainer({"type": "quality"})
+        container_with_profile = stack.findContainer({"type": "quality"})
         serialized = container_with_profile.serialize()
 
+        data = {"global_quality": serialized}
+
+        manager = ExtruderManager.getInstance()
+        for extruder in manager.getMachineExtruders(stack.getBottom().getId()):
+            extruder_quality = extruder.findContainer({"type": "quality"})
+            extruder_serialized = extruder_quality.serialize()
+            data.setdefault("extruder_quality", []).append(extruder_serialized)
+
+        json_string = json.dumps(data)
+
         # Escape characters that have a special meaning in g-code comments.
         pattern = re.compile("|".join(GCodeWriter.escape_characters.keys()))
+
         # Perform the replacement with a regular expression.
-        serialized = pattern.sub(lambda m: GCodeWriter.escape_characters[re.escape(m.group(0))], serialized)
+        escaped_string = pattern.sub(lambda m: GCodeWriter.escape_characters[re.escape(m.group(0))], json_string)
 
         # Introduce line breaks so that each comment is no longer than 80 characters. Prepend each line with the prefix.
         result = ""
 
         # Lines have 80 characters, so the payload of each line is 80 - prefix.
-        for pos in range(0, len(serialized), 80 - prefix_length):
-            result += prefix + serialized[pos : pos + 80 - prefix_length] + "\n"
-        serialized = result
-
-        return serialized
+        for pos in range(0, len(escaped_string), 80 - prefix_length):
+            result += prefix + escaped_string[pos : pos + 80 - prefix_length] + "\n"
+        return result