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 M107       ;start with the fan off\r
  84 \r
  85 G28 X0 Y0  ;move X/Y to min endstops\r
  86 G28 Z0     ;move Z to min endstops\r
  87 \r
  88 ; if your prints start too high, try changing the Z0.0 below\r
  89 ; to Z1.0 - the number after the Z is the actual, physical\r
  90 ; height of the nozzle in mm. This can take some messing around\r
  91 ; with to get just right...\r
  92 G92 X0 Y0 Z0 E0         ;reset software position to front/left/z=0.0\r
  93 G1 Z15.0 F{max_z_speed} ;move the platform down 15mm\r
  94 G92 E0                  ;zero the extruded length\r
  95 \r
  96 G1 F200 E5              ;extrude 5mm of feed stock\r
  97 G1 F200 E3.5            ;reverse feed stock by 1.5mm\r
  98 G92 E0                  ;zero the extruded length again\r
  99 \r
 100 ;go to the middle of the platform, and move to Z=0 before starting the print.\r
 101 G1 X{machine_center_x} Y{machine_center_y} F{travel_speed}\r
 102 G1 Z0.0 F{max_z_speed}\r
 103 """,\r
 104 #######################################################################################\r
 105         'end.gcode': """;End GCode\r
 106 M104 S0                    ;extruder heat off\r
 107 G91                        ;relative positioning\r
 108 G1 Z+10 E-5 F{max_z_speed} ;move Z up a bit and retract filament by 5mm\r
 109 G28 X0 Y0                  ;move X/Y to min endstops, so the head is out of the way\r
 110 M84                        ;steppers off\r
 111 G90                        ;absolute positioning\r
 112 """,\r
 113 #######################################################################################\r
 114         'support_start.gcode': '',\r
 115         'support_end.gcode': '',\r
 116         'cool_start.gcode': '',\r
 117         'cool_end.gcode': '',\r
 118         'replace.csv': '',\r
 119 #######################################################################################\r
 120         '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
 121 G92 E0\r
 122 G1 Z{clear_z} E-5 F{max_z_speed}\r
 123 G92 E0\r
 124 G1 X{machine_center_x} Y{machine_center_y} F{travel_speed}\r
 125 G1 F200 E5.5\r
 126 G92 E0\r
 127 G1 Z0 F{max_z_speed}\r
 128 """,\r
 129 #######################################################################################\r
 130         'switchExtruder.gcode': """;Switch between the current extruder and the next extruder, when printing with multiple extruders.\r
 131 G1 E-5 F5000\r
 132 G92 E0\r
 133 T{extruder}\r
 134 G1 E5 F5000\r
 135 G92 E0\r
 136 """,\r
 137 }\r
 138 preferencesDefaultSettings = {\r
 139         'wizardDone': 'False',\r
 140         'startMode': 'Simple',\r
 141         'lastFile': '',\r
 142         'machine_width': '205',\r
 143         'machine_depth': '205',\r
 144         'machine_height': '200',\r
 145         'extruder_amount': '1',\r
 146         'extruder_offset_x1': '-22.0',\r
 147         'extruder_offset_y1': '0.0',\r
 148         'extruder_offset_x2': '0.0',\r
 149         'extruder_offset_y2': '0.0',\r
 150         'extruder_offset_x3': '0.0',\r
 151         'extruder_offset_y3': '0.0',\r
 152         'filament_density': '1300',\r
 153         'steps_per_e': '0',\r
 154         'serial_port': 'AUTO',\r
 155         'serial_baud': '250000',\r
 156         'slicer': 'Cura (Skeinforge based)',\r
 157         'save_profile': 'False',\r
 158         'filament_cost_kg': '0',\r
 159         'filament_cost_meter': '0',\r
 160         \r
 161         'extruder_head_size_min_x': '70.0',\r
 162         'extruder_head_size_min_y': '18.0',\r
 163         'extruder_head_size_max_x': '18.0',\r
 164         'extruder_head_size_max_y': '35.0',\r
 165 }\r
 166 \r
 167 #########################################################\r
 168 ## Profile and preferences functions\r
 169 #########################################################\r
 170 \r
 171 ## Profile functions\r
 172 def getDefaultProfilePath():\r
 173         return os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../current_profile.ini"))\r
 174 \r
 175 def loadGlobalProfile(filename):\r
 176         #Read a configuration file as global config\r
 177         global globalProfileParser\r
 178         globalProfileParser = ConfigParser.ConfigParser()\r
 179         globalProfileParser.read(filename)\r
 180 \r
 181 def saveGlobalProfile(filename):\r
 182         #Save the current profile to an ini file\r
 183         globalProfileParser.write(open(filename, 'w'))\r
 184 \r
 185 def loadGlobalProfileFromString(options):\r
 186         global globalProfileParser\r
 187         globalProfileParser = ConfigParser.ConfigParser()\r
 188         globalProfileParser.add_section('profile')\r
 189         globalProfileParser.add_section('alterations')\r
 190         options = base64.b64decode(options)\r
 191         options = zlib.decompress(options)\r
 192         (profileOpts, alt) = options.split('\f', 1)\r
 193         for option in profileOpts.split('\b'):\r
 194                 if len(option) > 0:\r
 195                         (key, value) = option.split('=', 1)\r
 196                         globalProfileParser.set('profile', key, value)\r
 197         for option in alt.split('\b'):\r
 198                 if len(option) > 0:\r
 199                         (key, value) = option.split('=', 1)\r
 200                         globalProfileParser.set('alterations', key, value)\r
 201 \r
 202 def getGlobalProfileString():\r
 203         global globalProfileParser\r
 204         if not globals().has_key('globalProfileParser'):\r
 205                 loadGlobalProfile(getDefaultProfilePath())\r
 206         \r
 207         p = []\r
 208         alt = []\r
 209         tempDone = []\r
 210         if globalProfileParser.has_section('profile'):\r
 211                 for key in globalProfileParser.options('profile'):\r
 212                         if key in tempOverride:\r
 213                                 p.append(key + "=" + unicode(tempOverride[key]))\r
 214                                 tempDone.append(key)\r
 215                         else:\r
 216                                 p.append(key + "=" + globalProfileParser.get('profile', key))\r
 217         if globalProfileParser.has_section('alterations'):\r
 218                 for key in globalProfileParser.options('alterations'):\r
 219                         if key in tempOverride:\r
 220                                 p.append(key + "=" + tempOverride[key])\r
 221                                 tempDone.append(key)\r
 222                         else:\r
 223                                 alt.append(key + "=" + globalProfileParser.get('alterations', key))\r
 224         for key in tempOverride:\r
 225                 if key not in tempDone:\r
 226                         p.append(key + "=" + unicode(tempOverride[key]))\r
 227         ret = '\b'.join(p) + '\f' + '\b'.join(alt)\r
 228         ret = base64.b64encode(zlib.compress(ret, 9))\r
 229         return ret\r
 230 \r
 231 def getProfileSetting(name):\r
 232         if name in tempOverride:\r
 233                 return unicode(tempOverride[name])\r
 234         #Check if we have a configuration file loaded, else load the default.\r
 235         if not globals().has_key('globalProfileParser'):\r
 236                 loadGlobalProfile(getDefaultProfilePath())\r
 237         if not globalProfileParser.has_option('profile', name):\r
 238                 if name in profileDefaultSettings:\r
 239                         default = profileDefaultSettings[name]\r
 240                 else:\r
 241                         print "Missing default setting for: '" + name + "'"\r
 242                         profileDefaultSettings[name] = ''\r
 243                         default = ''\r
 244                 if not globalProfileParser.has_section('profile'):\r
 245                         globalProfileParser.add_section('profile')\r
 246                 globalProfileParser.set('profile', name, str(default))\r
 247                 #print name + " not found in profile, so using default: " + str(default)\r
 248                 return default\r
 249         return globalProfileParser.get('profile', name)\r
 250 \r
 251 def getProfileSettingFloat(name):\r
 252         try:\r
 253                 return float(eval(getProfileSetting(name), {}, {}))\r
 254         except (ValueError, SyntaxError):\r
 255                 return 0.0\r
 256 \r
 257 def putProfileSetting(name, value):\r
 258         #Check if we have a configuration file loaded, else load the default.\r
 259         if not globals().has_key('globalProfileParser'):\r
 260                 loadGlobalProfile(getDefaultProfilePath())\r
 261         if not globalProfileParser.has_section('profile'):\r
 262                 globalProfileParser.add_section('profile')\r
 263         globalProfileParser.set('profile', name, str(value))\r
 264 \r
 265 def isProfileSetting(name):\r
 266         if name in profileDefaultSettings:\r
 267                 return True\r
 268         return False\r
 269 \r
 270 ## Preferences functions\r
 271 global globalPreferenceParser\r
 272 globalPreferenceParser = None\r
 273 \r
 274 def getPreferencePath():\r
 275         return os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../preferences.ini"))\r
 276 \r
 277 def getPreferenceFloat(name):\r
 278         try:\r
 279                 return float(eval(getPreference(name), {}, {}))\r
 280         except (ValueError, SyntaxError):\r
 281                 return 0.0\r
 282 \r
 283 def getPreference(name):\r
 284         if name in tempOverride:\r
 285                 return unicode(tempOverride[name])\r
 286         global globalPreferenceParser\r
 287         if globalPreferenceParser == None:\r
 288                 globalPreferenceParser = ConfigParser.ConfigParser()\r
 289                 globalPreferenceParser.read(getPreferencePath())\r
 290         if not globalPreferenceParser.has_option('preference', name):\r
 291                 if name in preferencesDefaultSettings:\r
 292                         default = preferencesDefaultSettings[name]\r
 293                 else:\r
 294                         print "Missing default setting for: '" + name + "'"\r
 295                         preferencesDefaultSettings[name] = ''\r
 296                         default = ''\r
 297                 if not globalPreferenceParser.has_section('preference'):\r
 298                         globalPreferenceParser.add_section('preference')\r
 299                 globalPreferenceParser.set('preference', name, str(default))\r
 300                 #print name + " not found in preferences, so using default: " + str(default)\r
 301                 return default\r
 302         return unicode(globalPreferenceParser.get('preference', name), "utf-8")\r
 303 \r
 304 def putPreference(name, value):\r
 305         #Check if we have a configuration file loaded, else load the default.\r
 306         global globalPreferenceParser\r
 307         if globalPreferenceParser == None:\r
 308                 globalPreferenceParser = ConfigParser.ConfigParser()\r
 309                 globalPreferenceParser.read(getPreferencePath())\r
 310         if not globalPreferenceParser.has_section('preference'):\r
 311                 globalPreferenceParser.add_section('preference')\r
 312         globalPreferenceParser.set('preference', name, unicode(value).encode("utf-8"))\r
 313         globalPreferenceParser.write(open(getPreferencePath(), 'w'))\r
 314 \r
 315 def isPreference(name):\r
 316         if name in preferencesDefaultSettings:\r
 317                 return True\r
 318         return False\r
 319 \r
 320 ## Temp overrides for multi-extruder slicing and the project planner.\r
 321 tempOverride = {}\r
 322 def setTempOverride(name, value):\r
 323         tempOverride[name] = value\r
 324 def resetTempOverride():\r
 325         tempOverride.clear()\r
 326 \r
 327 #########################################################\r
 328 ## Utility functions to calculate common profile values\r
 329 #########################################################\r
 330 def calculateEdgeWidth():\r
 331         wallThickness = getProfileSettingFloat('wall_thickness')\r
 332         nozzleSize = getProfileSettingFloat('nozzle_size')\r
 333         \r
 334         if wallThickness < nozzleSize:\r
 335                 return wallThickness\r
 336 \r
 337         lineCount = int(wallThickness / nozzleSize)\r
 338         lineWidth = wallThickness / lineCount\r
 339         lineWidthAlt = wallThickness / (lineCount + 1)\r
 340         if lineWidth > nozzleSize * 1.5:\r
 341                 return lineWidthAlt\r
 342         return lineWidth\r
 343 \r
 344 def calculateLineCount():\r
 345         wallThickness = getProfileSettingFloat('wall_thickness')\r
 346         nozzleSize = getProfileSettingFloat('nozzle_size')\r
 347         \r
 348         if wallThickness < nozzleSize:\r
 349                 return 1\r
 350 \r
 351         lineCount = int(wallThickness / nozzleSize + 0.0001)\r
 352         lineWidth = wallThickness / lineCount\r
 353         lineWidthAlt = wallThickness / (lineCount + 1)\r
 354         if lineWidth > nozzleSize * 1.5:\r
 355                 return lineCount + 1\r
 356         return lineCount\r
 357 \r
 358 def calculateSolidLayerCount():\r
 359         layerHeight = getProfileSettingFloat('layer_height')\r
 360         solidThickness = getProfileSettingFloat('solid_layer_thickness')\r
 361         return int(math.ceil(solidThickness / layerHeight - 0.0001))\r
 362 \r
 363 #########################################################\r
 364 ## Alteration file functions\r
 365 #########################################################\r
 366 def replaceTagMatch(m):\r
 367         tag = m.group(0)[1:-1]\r
 368         if tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:\r
 369                 f = getProfileSettingFloat(tag) * 60\r
 370         elif isProfileSetting(tag):\r
 371                 f = getProfileSettingFloat(tag)\r
 372         elif isPreference(tag):\r
 373                 f = getProfileSettingFloat(tag)\r
 374         else:\r
 375                 return tag\r
 376         if (f % 1) == 0:\r
 377                 return str(int(f))\r
 378         return str(f)\r
 379 \r
 380 ### Get aleration raw contents. (Used internally in Cura)\r
 381 def getAlterationFile(filename):\r
 382         #Check if we have a configuration file loaded, else load the default.\r
 383         if not globals().has_key('globalProfileParser'):\r
 384                 loadGlobalProfile(getDefaultProfilePath())\r
 385         \r
 386         if not globalProfileParser.has_option('alterations', filename):\r
 387                 if filename in alterationDefault:\r
 388                         default = alterationDefault[filename]\r
 389                 else:\r
 390                         print "Missing default alteration for: '" + filename + "'"\r
 391                         alterationDefault[filename] = ''\r
 392                         default = ''\r
 393                 if not globalProfileParser.has_section('alterations'):\r
 394                         globalProfileParser.add_section('alterations')\r
 395                 #print "Using default for: %s" % (filename)\r
 396                 globalProfileParser.set('alterations', filename, default)\r
 397         return unicode(globalProfileParser.get('alterations', filename), "utf-8")\r
 398 \r
 399 def setAlterationFile(filename, value):\r
 400         #Check if we have a configuration file loaded, else load the default.\r
 401         if not globals().has_key('globalProfileParser'):\r
 402                 loadGlobalProfile(getDefaultProfilePath())\r
 403         if not globalProfileParser.has_section('alterations'):\r
 404                 globalProfileParser.add_section('alterations')\r
 405         globalProfileParser.set('alterations', filename, value.encode("utf-8"))\r
 406         saveGlobalProfile(getDefaultProfilePath())\r
 407 \r
 408 ### Get the alteration file for output. (Used by Skeinforge)\r
 409 def getAlterationFileContents(filename):\r
 410         prefix = ''\r
 411         alterationContents = getAlterationFile(filename)\r
 412         if filename == 'start.gcode':\r
 413                 #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
 414                 #We also set our steps per E here, if configured.\r
 415                 eSteps = getPreferenceFloat('steps_per_e')\r
 416                 if eSteps > 0:\r
 417                         prefix += 'M92 E%f\n' % (eSteps)\r
 418                 temp = getProfileSettingFloat('print_temperature')\r
 419                 if temp > 0 and not '{print_temperature}' in alterationContents:\r
 420                         prefix += 'M109 S%f\n' % (temp)\r
 421         elif filename == 'replace.csv':\r
 422                 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.\r
 423                 prefix = 'M101\nM103\n'\r
 424         \r
 425         return unicode(prefix + re.sub("\{[^\}]*\}", replaceTagMatch, alterationContents).rstrip() + '\n').encode('utf-8')\r
 426 \r