Cura/util/profile.py

   1 from __future__ import absolute_import\r
   2 from __future__ import division\r
   3 #Init has to be imported first because it has code to workaround the python bug where relative imports don't work if the module is imported as a main module.\r
   4 import __init__\r
   5 \r
   6 import ConfigParser, os, traceback, math, re, zlib, base64\r
   7 \r
   8 #########################################################\r
   9 ## Default settings when none are found.\r
  10 #########################################################\r
  11 \r
  12 #Single place to store the defaults, so we have a consistent set of default settings.\r
  13 profileDefaultSettings = {\r
  14         'nozzle_size': '0.4',\r
  15         'layer_height': '0.2',\r
  16         'wall_thickness': '0.8',\r
  17         'solid_layer_thickness': '0.6',\r
  18         'fill_density': '20',\r
  19         'skirt_line_count': '1',\r
  20         'skirt_gap': '3.0',\r
  21         'print_speed': '50',\r
  22         'print_temperature': '0',\r
  23         'support': 'None',\r
  24         'filament_diameter': '2.89',\r
  25         'filament_density': '1.00',\r
  26         'machine_center_x': '100',\r
  27         'machine_center_y': '100',\r
  28         'retraction_min_travel': '5.0',\r
  29         'retraction_speed': '40.0',\r
  30         'retraction_amount': '0.0',\r
  31         'retraction_extra': '0.0',\r
  32         'travel_speed': '150',\r
  33         'max_z_speed': '3.0',\r
  34         'bottom_layer_speed': '20',\r
  35         'cool_min_layer_time': '10',\r
  36         'fan_enabled': 'True',\r
  37         'fan_layer': '1',\r
  38         'fan_speed': '100',\r
  39         'model_scale': '1.0',\r
  40         'flip_x': 'False',\r
  41         'flip_y': 'False',\r
  42         'flip_z': 'False',\r
  43         'swap_xz': 'False',\r
  44         'swap_yz': 'False',\r
  45         'model_rotate_base': '0',\r
  46         'model_multiply_x': '1',\r
  47         'model_multiply_y': '1',\r
  48         'extra_base_wall_thickness': '0.0',\r
  49         'sequence': 'Loops > Perimeter > Infill',\r
  50         'force_first_layer_sequence': 'True',\r
  51         'infill_type': 'Line',\r
  52         'solid_top': 'True',\r
  53         'fill_overlap': '15',\r
  54         'support_rate': '50',\r
  55         'support_distance': '0.5',\r
  56         'support_margin': '3.0',\r
  57         'joris': 'False',\r
  58         'enable_skin': 'False',\r
  59         'enable_raft': 'False',\r
  60         'cool_min_feedrate': '5',\r
  61         'bridge_speed': '100',\r
  62         'bridge_material_amount': '100',\r
  63         'raft_margin': '5',\r
  64         'raft_base_material_amount': '100',\r
  65         'raft_interface_material_amount': '100',\r
  66         'bottom_thickness': '0.3',\r
  67         \r
  68         'enable_dwindle': 'False',\r
  69         'dwindle_pent_up_volume': '0.4',\r
  70         'dwindle_slowdown_volume': '5.0',\r
  71 \r
  72         'add_start_end_gcode': 'True',\r
  73         'gcode_extension': 'gcode',\r
  74         'alternative_center': '',\r
  75         'clear_z': '0.0',\r
  76         'extruder': '0',\r
  77 }\r
  78 alterationDefault = {\r
  79 #######################################################################################\r
  80         'start.gcode': """;Start GCode\r
  81 G21        ;metric values\r
  82 G90        ;absolute positioning\r
  83 \r
  84 G28 X0 Y0  ;move X/Y to min endstops\r
  85 G28 Z0     ;move Z to min endstops\r
  86 \r
  87 ; if your prints start too high, try changing the Z0.0 below\r
  88 ; to Z1.0 - the number after the Z is the actual, physical\r
  89 ; height of the nozzle in mm. This can take some messing around\r
  90 ; with to get just right...\r
  91 G92 X0 Y0 Z0 E0         ;reset software position to front/left/z=0.0\r
  92 G1 Z15.0 F{max_z_speed} ;move the platform down 15mm\r
  93 G92 E0                  ;zero the extruded length\r
  94 \r
  95 G1 F200 E5              ;extrude 5mm of feed stock\r
  96 G1 F200 E3.5            ;reverse feed stock by 1.5mm\r
  97 G92 E0                  ;zero the extruded length again\r
  98 \r
  99 ;go to the middle of the platform, and move to Z=0 before starting the print.\r
 100 G1 X{machine_center_x} Y{machine_center_y} F{travel_speed}\r
 101 G1 Z0.0 F{max_z_speed}\r
 102 """,\r
 103 #######################################################################################\r
 104         'end.gcode': """;End GCode\r
 105 M104 S0                    ;extruder heat off\r
 106 G91                        ;relative positioning\r
 107 G1 Z+10 E-5 F{max_z_speed} ;move Z up a bit and retract filament by 5mm\r
 108 G28 X0 Y0                  ;move X/Y to min endstops, so the head is out of the way\r
 109 M84                        ;steppers off\r
 110 G90                        ;absolute positioning\r
 111 """,\r
 112 #######################################################################################\r
 113         'support_start.gcode': '',\r
 114         'support_end.gcode': '',\r
 115         'cool_start.gcode': '',\r
 116         'cool_end.gcode': '',\r
 117         'replace.csv': '',\r
 118 #######################################################################################\r
 119         'nextobject.gcode': """;Move to next object on the platform. clear_z is the minimal z height we need to make sure we do not hit any objects.\r
 120 G92 E0\r
 121 G1 Z{clear_z} E-5 F{max_z_speed}\r
 122 G92 E0\r
 123 G1 X{machine_center_x} Y{machine_center_y} F{travel_speed}\r
 124 G1 F200 E5.5\r
 125 G92 E0\r
 126 G1 Z0 F{max_z_speed}\r
 127 """,\r
 128 #######################################################################################\r
 129         'switchExtruder.gcode': """;Switch between the current extruder and the next extruder, when printing with multiple extruders.\r
 130 G1 E-5 F5000\r
 131 G92 E0\r
 132 T{extruder}\r
 133 G1 E5 F5000\r
 134 G92 E0\r
 135 """,\r
 136 }\r
 137 preferencesDefaultSettings = {\r
 138         'wizardDone': 'False',\r
 139         'startMode': 'Simple',\r
 140         'lastFile': '',\r
 141         'machine_width': '205',\r
 142         'machine_depth': '205',\r
 143         'machine_height': '200',\r
 144         'extruder_amount': '1',\r
 145         'extruder_offset_x1': '-22.0',\r
 146         'extruder_offset_y1': '0.0',\r
 147         'extruder_offset_x2': '0.0',\r
 148         'extruder_offset_y2': '0.0',\r
 149         'extruder_offset_x3': '0.0',\r
 150         'extruder_offset_y3': '0.0',\r
 151         'filament_density': '1300',\r
 152         'steps_per_e': '0',\r
 153         'serial_port': 'AUTO',\r
 154         'serial_baud': '250000',\r
 155         'slicer': 'Cura (Skeinforge based)',\r
 156         'save_profile': 'False',\r
 157         'filament_cost_kg': '0',\r
 158         'filament_cost_meter': '0',\r
 159         \r
 160         'extruder_head_size_min_x': '70.0',\r
 161         'extruder_head_size_min_y': '18.0',\r
 162         'extruder_head_size_max_x': '18.0',\r
 163         'extruder_head_size_max_y': '35.0',\r
 164 }\r
 165 \r
 166 #########################################################\r
 167 ## Profile and preferences functions\r
 168 #########################################################\r
 169 \r
 170 ## Profile functions\r
 171 def getDefaultProfilePath():\r
 172         return os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../current_profile.ini"))\r
 173 \r
 174 def loadGlobalProfile(filename):\r
 175         #Read a configuration file as global config\r
 176         global globalProfileParser\r
 177         globalProfileParser = ConfigParser.ConfigParser()\r
 178         globalProfileParser.read(filename)\r
 179 \r
 180 def saveGlobalProfile(filename):\r
 181         #Save the current profile to an ini file\r
 182         globalProfileParser.write(open(filename, 'w'))\r
 183 \r
 184 def loadGlobalProfileFromString(options):\r
 185         global globalProfileParser\r
 186         globalProfileParser = ConfigParser.ConfigParser()\r
 187         globalProfileParser.add_section('profile')\r
 188         globalProfileParser.add_section('alterations')\r
 189         options = base64.b64decode(options)\r
 190         options = zlib.decompress(options)\r
 191         (profileOpts, alt) = options.split('\f', 1)\r
 192         for option in profileOpts.split('\b'):\r
 193                 if len(option) > 0:\r
 194                         (key, value) = option.split('=', 1)\r
 195                         globalProfileParser.set('profile', key, value)\r
 196         for option in alt.split('\b'):\r
 197                 if len(option) > 0:\r
 198                         (key, value) = option.split('=', 1)\r
 199                         globalProfileParser.set('alterations', key, value)\r
 200 \r
 201 def getGlobalProfileString():\r
 202         global globalProfileParser\r
 203         if not globals().has_key('globalProfileParser'):\r
 204                 loadGlobalProfile(getDefaultProfilePath())\r
 205         \r
 206         p = []\r
 207         alt = []\r
 208         tempDone = []\r
 209         if globalProfileParser.has_section('profile'):\r
 210                 for key in globalProfileParser.options('profile'):\r
 211                         if key in tempOverride:\r
 212                                 p.append(key + "=" + unicode(tempOverride[key]))\r
 213                                 tempDone.append(key)\r
 214                         else:\r
 215                                 p.append(key + "=" + globalProfileParser.get('profile', key))\r
 216         if globalProfileParser.has_section('alterations'):\r
 217                 for key in globalProfileParser.options('alterations'):\r
 218                         if key in tempOverride:\r
 219                                 p.append(key + "=" + tempOverride[key])\r
 220                                 tempDone.append(key)\r
 221                         else:\r
 222                                 alt.append(key + "=" + globalProfileParser.get('alterations', key))\r
 223         for key in tempOverride:\r
 224                 if key not in tempDone:\r
 225                         p.append(key + "=" + unicode(tempOverride[key]))\r
 226         ret = '\b'.join(p) + '\f' + '\b'.join(alt)\r
 227         ret = base64.b64encode(zlib.compress(ret, 9))\r
 228         return ret\r
 229 \r
 230 def getProfileSetting(name):\r
 231         if name in tempOverride:\r
 232                 return unicode(tempOverride[name])\r
 233         #Check if we have a configuration file loaded, else load the default.\r
 234         if not globals().has_key('globalProfileParser'):\r
 235                 loadGlobalProfile(getDefaultProfilePath())\r
 236         if not globalProfileParser.has_option('profile', name):\r
 237                 if name in profileDefaultSettings:\r
 238                         default = profileDefaultSettings[name]\r
 239                 else:\r
 240                         print "Missing default setting for: '" + name + "'"\r
 241                         profileDefaultSettings[name] = ''\r
 242                         default = ''\r
 243                 if not globalProfileParser.has_section('profile'):\r
 244                         globalProfileParser.add_section('profile')\r
 245                 globalProfileParser.set('profile', name, str(default))\r
 246                 #print name + " not found in profile, so using default: " + str(default)\r
 247                 return default\r
 248         return globalProfileParser.get('profile', name)\r
 249 \r
 250 def getProfileSettingFloat(name):\r
 251         try:\r
 252                 return float(eval(getProfileSetting(name), {}, {}))\r
 253         except (ValueError, SyntaxError):\r
 254                 return 0.0\r
 255 \r
 256 def putProfileSetting(name, value):\r
 257         #Check if we have a configuration file loaded, else load the default.\r
 258         if not globals().has_key('globalProfileParser'):\r
 259                 loadGlobalProfile(getDefaultProfilePath())\r
 260         if not globalProfileParser.has_section('profile'):\r
 261                 globalProfileParser.add_section('profile')\r
 262         globalProfileParser.set('profile', name, str(value))\r
 263 \r
 264 def isProfileSetting(name):\r
 265         if name in profileDefaultSettings:\r
 266                 return True\r
 267         return False\r
 268 \r
 269 ## Preferences functions\r
 270 global globalPreferenceParser\r
 271 globalPreferenceParser = None\r
 272 \r
 273 def getPreferencePath():\r
 274         return os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../preferences.ini"))\r
 275 \r
 276 def getPreferenceFloat(name):\r
 277         try:\r
 278                 return float(eval(getPreference(name), {}, {}))\r
 279         except (ValueError, SyntaxError):\r
 280                 return 0.0\r
 281 \r
 282 def getPreference(name):\r
 283         if name in tempOverride:\r
 284                 return unicode(tempOverride[name])\r
 285         global globalPreferenceParser\r
 286         if globalPreferenceParser == None:\r
 287                 globalPreferenceParser = ConfigParser.ConfigParser()\r
 288                 globalPreferenceParser.read(getPreferencePath())\r
 289         if not globalPreferenceParser.has_option('preference', name):\r
 290                 if name in preferencesDefaultSettings:\r
 291                         default = preferencesDefaultSettings[name]\r
 292                 else:\r
 293                         print "Missing default setting for: '" + name + "'"\r
 294                         preferencesDefaultSettings[name] = ''\r
 295                         default = ''\r
 296                 if not globalPreferenceParser.has_section('preference'):\r
 297                         globalPreferenceParser.add_section('preference')\r
 298                 globalPreferenceParser.set('preference', name, str(default))\r
 299                 #print name + " not found in preferences, so using default: " + str(default)\r
 300                 return default\r
 301         return unicode(globalPreferenceParser.get('preference', name), "utf-8")\r
 302 \r
 303 def putPreference(name, value):\r
 304         #Check if we have a configuration file loaded, else load the default.\r
 305         global globalPreferenceParser\r
 306         if globalPreferenceParser == None:\r
 307                 globalPreferenceParser = ConfigParser.ConfigParser()\r
 308                 globalPreferenceParser.read(getPreferencePath())\r
 309         if not globalPreferenceParser.has_section('preference'):\r
 310                 globalPreferenceParser.add_section('preference')\r
 311         globalPreferenceParser.set('preference', name, unicode(value).encode("utf-8"))\r
 312         globalPreferenceParser.write(open(getPreferencePath(), 'w'))\r
 313 \r
 314 def isPreference(name):\r
 315         if name in preferencesDefaultSettings:\r
 316                 return True\r
 317         return False\r
 318 \r
 319 ## Temp overrides for multi-extruder slicing and the project planner.\r
 320 tempOverride = {}\r
 321 def setTempOverride(name, value):\r
 322         tempOverride[name] = value\r
 323 def resetTempOverride():\r
 324         tempOverride.clear()\r
 325 \r
 326 #########################################################\r
 327 ## Utility functions to calculate common profile values\r
 328 #########################################################\r
 329 def calculateEdgeWidth():\r
 330         wallThickness = getProfileSettingFloat('wall_thickness')\r
 331         nozzleSize = getProfileSettingFloat('nozzle_size')\r
 332         \r
 333         if wallThickness < nozzleSize:\r
 334                 return wallThickness\r
 335 \r
 336         lineCount = int(wallThickness / nozzleSize)\r
 337         lineWidth = wallThickness / lineCount\r
 338         lineWidthAlt = wallThickness / (lineCount + 1)\r
 339         if lineWidth > nozzleSize * 1.5:\r
 340                 return lineWidthAlt\r
 341         return lineWidth\r
 342 \r
 343 def calculateLineCount():\r
 344         wallThickness = getProfileSettingFloat('wall_thickness')\r
 345         nozzleSize = getProfileSettingFloat('nozzle_size')\r
 346         \r
 347         if wallThickness < nozzleSize:\r
 348                 return 1\r
 349 \r
 350         lineCount = int(wallThickness / nozzleSize + 0.0001)\r
 351         lineWidth = wallThickness / lineCount\r
 352         lineWidthAlt = wallThickness / (lineCount + 1)\r
 353         if lineWidth > nozzleSize * 1.5:\r
 354                 return lineCount + 1\r
 355         return lineCount\r
 356 \r
 357 def calculateSolidLayerCount():\r
 358         layerHeight = getProfileSettingFloat('layer_height')\r
 359         solidThickness = getProfileSettingFloat('solid_layer_thickness')\r
 360         return int(math.ceil(solidThickness / layerHeight - 0.0001))\r
 361 \r
 362 #########################################################\r
 363 ## Alteration file functions\r
 364 #########################################################\r
 365 def replaceTagMatch(m):\r
 366         tag = m.group(0)[1:-1]\r
 367         if tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:\r
 368                 f = getProfileSettingFloat(tag) * 60\r
 369         elif isProfileSetting(tag):\r
 370                 f = getProfileSettingFloat(tag)\r
 371         elif isPreference(tag):\r
 372                 f = getProfileSettingFloat(tag)\r
 373         else:\r
 374                 return tag\r
 375         if (f % 1) == 0:\r
 376                 return str(int(f))\r
 377         return str(f)\r
 378 \r
 379 ### Get aleration raw contents. (Used internally in Cura)\r
 380 def getAlterationFile(filename):\r
 381         #Check if we have a configuration file loaded, else load the default.\r
 382         if not globals().has_key('globalProfileParser'):\r
 383                 loadGlobalProfile(getDefaultProfilePath())\r
 384         \r
 385         if not globalProfileParser.has_option('alterations', filename):\r
 386                 if filename in alterationDefault:\r
 387                         default = alterationDefault[filename]\r
 388                 else:\r
 389                         print "Missing default alteration for: '" + filename + "'"\r
 390                         alterationDefault[filename] = ''\r
 391                         default = ''\r
 392                 if not globalProfileParser.has_section('alterations'):\r
 393                         globalProfileParser.add_section('alterations')\r
 394                 #print "Using default for: %s" % (filename)\r
 395                 globalProfileParser.set('alterations', filename, default)\r
 396         return unicode(globalProfileParser.get('alterations', filename), "utf-8")\r
 397 \r
 398 def setAlterationFile(filename, value):\r
 399         #Check if we have a configuration file loaded, else load the default.\r
 400         if not globals().has_key('globalProfileParser'):\r
 401                 loadGlobalProfile(getDefaultProfilePath())\r
 402         if not globalProfileParser.has_section('alterations'):\r
 403                 globalProfileParser.add_section('alterations')\r
 404         globalProfileParser.set('alterations', filename, value.encode("utf-8"))\r
 405         saveGlobalProfile(getDefaultProfilePath())\r
 406 \r
 407 ### Get the alteration file for output. (Used by Skeinforge)\r
 408 def getAlterationFileContents(filename):\r
 409         prefix = ''\r
 410         alterationContents = getAlterationFile(filename)\r
 411         if filename == 'start.gcode':\r
 412                 #For the start code, hack the temperature and the steps per E value into it. So the temperature is reached before the start code extrusion.\r
 413                 #We also set our steps per E here, if configured.\r
 414                 eSteps = getPreferenceFloat('steps_per_e')\r
 415                 if eSteps > 0:\r
 416                         prefix += 'M92 E%f\n' % (eSteps)\r
 417                 temp = getProfileSettingFloat('print_temperature')\r
 418                 if temp > 0 and not '{print_temperature}' in alterationContents:\r
 419                         prefix += 'M109 S%f\n' % (temp)\r
 420         elif filename == 'replace.csv':\r
 421                 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.\r
 422                 prefix = 'M101\nM103\n'\r
 423         \r
 424         return unicode(prefix + re.sub("\{[^\}]*\}", replaceTagMatch, alterationContents).rstrip() + '\n').encode('utf-8')\r
 425 \r