1 from __future__ import absolute_import
2 from __future__ import division
4 import os, traceback, math, re, zlib, base64, time, sys, platform, glob, string, stat
5 import cPickle as pickle
6 if sys.version_info[0] < 3:
9 import configparser as ConfigParser
11 from Cura.util import resources
12 from Cura.util import version
14 #########################################################
15 ## Default settings when none are found.
16 #########################################################
18 #Single place to store the defaults, so we have a consistent set of default settings.
19 profileDefaultSettings = {
21 'layer_height': '0.2',
22 'wall_thickness': '0.8',
23 'solid_layer_thickness': '0.6',
25 'skirt_line_count': '1',
28 'print_temperature': '220',
29 'print_bed_temperature': '70',
31 'filament_diameter': '2.89',
32 'filament_density': '1.00',
33 'retraction_min_travel': '5.0',
34 'retraction_enable': 'False',
35 'retraction_speed': '40.0',
36 'retraction_amount': '4.5',
37 'retraction_extra': '0.0',
38 'retract_on_jumps_only': 'True',
39 'travel_speed': '150',
41 'bottom_layer_speed': '20',
42 'cool_min_layer_time': '5',
43 'fan_enabled': 'True',
46 'fan_speed_max': '100',
53 'model_rotate_base': '0',
54 'model_multiply_x': '1',
55 'model_multiply_y': '1',
56 'extra_base_wall_thickness': '0.0',
57 'sequence': 'Loops > Perimeter > Infill',
58 'force_first_layer_sequence': 'True',
59 'infill_type': 'Line',
63 'support_distance': '0.5',
64 'support_dual_extrusion': 'False',
66 'enable_skin': 'False',
67 'enable_raft': 'False',
68 'cool_min_feedrate': '10',
69 'bridge_speed': '100',
71 'raft_base_material_amount': '100',
72 'raft_interface_material_amount': '100',
73 'bottom_thickness': '0.3',
74 'hop_on_move': 'False',
76 'object_center_x': '-1',
77 'object_center_y': '-1',
79 'add_start_end_gcode': 'True',
80 'gcode_extension': 'gcode',
81 'alternative_center': '',
86 #######################################################################################
87 'start.gcode': """;Sliced {filename} at: {day} {date} {time}
88 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
89 ;Print time: {print_time}
90 ;Filament used: {filament_amount}m {filament_weight}g
91 ;Filament cost: {filament_cost}
93 G90 ;absolute positioning
94 M107 ;start with the fan off
96 G28 X0 Y0 ;move X/Y to min endstops
97 G28 Z0 ;move Z to min endstops
98 G92 X0 Y0 Z0 E0 ;reset software position to front/left/z=0.0
100 G1 Z15.0 F{max_z_speed} ;move the platform down 15mm
102 G92 E0 ;zero the extruded length
103 G1 F200 E3 ;extrude 3mm of feed stock
104 G92 E0 ;zero the extruded length again
107 #######################################################################################
108 'end.gcode': """;End GCode
109 M104 S0 ;extruder heater off
110 M140 S0 ;heated bed heater off (if you have it)
112 G91 ;relative positioning
113 G1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure
114 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
115 G28 X0 Y0 ;move X/Y to min endstops, so the head is out of the way
118 G90 ;absolute positioning
120 #######################################################################################
121 'support_start.gcode': '',
122 'support_end.gcode': '',
123 'cool_start.gcode': '',
124 'cool_end.gcode': '',
126 #######################################################################################
127 '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.
130 G91 ;relative positioning
131 G1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure
132 G1 Z+0.5 E-5 F{travel_speed} ;move Z up a bit and retract filament even more
133 G90 ;absolute positioning
135 G1 Z{clear_z} F{max_z_speed}
137 G1 X{object_center_x} Y{object_center_x} F{travel_speed}
141 #######################################################################################
142 'switchExtruder.gcode': """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
151 preferencesDefaultSettings = {
152 'startMode': 'Simple',
153 'lastFile': os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'example', 'UltimakerRobot_support.stl')),
154 'machine_width': '205',
155 'machine_depth': '205',
156 'machine_height': '200',
157 'machine_type': 'unknown',
158 'ultimaker_extruder_upgrade': 'False',
159 'has_heated_bed': 'False',
160 'extruder_amount': '1',
161 'extruder_offset_x1': '-22.0',
162 'extruder_offset_y1': '0.0',
163 'extruder_offset_x2': '0.0',
164 'extruder_offset_y2': '0.0',
165 'extruder_offset_x3': '0.0',
166 'extruder_offset_y3': '0.0',
167 'filament_density': '1300',
169 'serial_port': 'AUTO',
170 'serial_port_auto': '',
171 'serial_baud': 'AUTO',
172 'serial_baud_auto': '',
173 'slicer': 'Cura (Skeinforge based)',
174 'save_profile': 'False',
175 'filament_cost_kg': '0',
176 'filament_cost_meter': '0',
178 'sdshortnames': 'True',
180 'extruder_head_size_min_x': '70.0',
181 'extruder_head_size_min_y': '18.0',
182 'extruder_head_size_max_x': '18.0',
183 'extruder_head_size_max_y': '35.0',
184 'extruder_head_size_height': '80.0',
186 'model_colour': '#72CB30',
187 'model_colour2': '#CB3030',
188 'model_colour3': '#DDD93C',
189 'model_colour4': '#4550D3',
192 #########################################################
193 ## Profile and preferences functions
194 #########################################################
197 def getDefaultProfilePath():
198 if platform.system() == "Windows":
199 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
200 #If we have a frozen python install, we need to step out of the library.zip
201 if hasattr(sys, 'frozen'):
202 basePath = os.path.normpath(os.path.join(basePath, ".."))
204 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
205 if not os.path.isdir(basePath):
206 os.makedirs(basePath)
207 return os.path.join(basePath, 'current_profile.ini')
209 def loadGlobalProfile(filename):
210 #Read a configuration file as global config
211 global globalProfileParser
212 globalProfileParser = ConfigParser.ConfigParser()
213 globalProfileParser.read(filename)
215 def resetGlobalProfile():
216 #Read a configuration file as global config
217 global globalProfileParser
218 globalProfileParser = ConfigParser.ConfigParser()
220 if getPreference('machine_type') == 'ultimaker':
221 putProfileSetting('nozzle_size', '0.4')
222 if getPreference('ultimaker_extruder_upgrade') == 'True':
223 putProfileSetting('retraction_enable', 'True')
225 putProfileSetting('nozzle_size', '0.5')
227 def saveGlobalProfile(filename):
228 #Save the current profile to an ini file
229 globalProfileParser.write(open(filename, 'w'))
231 def loadGlobalProfileFromString(options):
232 global globalProfileParser
233 globalProfileParser = ConfigParser.ConfigParser()
234 globalProfileParser.add_section('profile')
235 globalProfileParser.add_section('alterations')
236 options = base64.b64decode(options)
237 options = zlib.decompress(options)
238 (profileOpts, alt) = options.split('\f', 1)
239 for option in profileOpts.split('\b'):
241 (key, value) = option.split('=', 1)
242 globalProfileParser.set('profile', key, value)
243 for option in alt.split('\b'):
245 (key, value) = option.split('=', 1)
246 globalProfileParser.set('alterations', key, value)
248 def getGlobalProfileString():
249 global globalProfileParser
250 if not globals().has_key('globalProfileParser'):
251 loadGlobalProfile(getDefaultProfilePath())
256 if globalProfileParser.has_section('profile'):
257 for key in globalProfileParser.options('profile'):
258 if key in tempOverride:
259 p.append(key + "=" + tempOverride[key])
262 p.append(key + "=" + globalProfileParser.get('profile', key))
263 if globalProfileParser.has_section('alterations'):
264 for key in globalProfileParser.options('alterations'):
265 if key in tempOverride:
266 p.append(key + "=" + tempOverride[key])
269 alt.append(key + "=" + globalProfileParser.get('alterations', key))
270 for key in tempOverride:
271 if key not in tempDone:
272 p.append(key + "=" + tempOverride[key])
273 ret = '\b'.join(p) + '\f' + '\b'.join(alt)
274 ret = base64.b64encode(zlib.compress(ret, 9))
277 def getProfileSetting(name):
278 if name in tempOverride:
279 return unicode(tempOverride[name], "utf-8")
280 #Check if we have a configuration file loaded, else load the default.
281 if not globals().has_key('globalProfileParser'):
282 loadGlobalProfile(getDefaultProfilePath())
283 if not globalProfileParser.has_option('profile', name):
284 if name in profileDefaultSettings:
285 default = profileDefaultSettings[name]
287 print("Missing default setting for: '" + name + "'")
288 profileDefaultSettings[name] = ''
290 if not globalProfileParser.has_section('profile'):
291 globalProfileParser.add_section('profile')
292 globalProfileParser.set('profile', name, str(default))
293 #print(name + " not found in profile, so using default: " + str(default))
295 return globalProfileParser.get('profile', name)
297 def getProfileSettingFloat(name):
299 setting = getProfileSetting(name).replace(',', '.')
300 return float(eval(setting, {}, {}))
301 except (ValueError, SyntaxError, TypeError):
304 def putProfileSetting(name, value):
305 #Check if we have a configuration file loaded, else load the default.
306 if not globals().has_key('globalProfileParser'):
307 loadGlobalProfile(getDefaultProfilePath())
308 if not globalProfileParser.has_section('profile'):
309 globalProfileParser.add_section('profile')
310 globalProfileParser.set('profile', name, str(value))
312 def isProfileSetting(name):
313 if name in profileDefaultSettings:
317 ## Preferences functions
318 global globalPreferenceParser
319 globalPreferenceParser = None
321 def getPreferencePath():
322 if platform.system() == "Windows":
323 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
324 #If we have a frozen python install, we need to step out of the library.zip
325 if hasattr(sys, 'frozen'):
326 basePath = os.path.normpath(os.path.join(basePath, ".."))
328 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
329 if not os.path.isdir(basePath):
330 os.makedirs(basePath)
331 return os.path.join(basePath, 'preferences.ini')
333 def getPreferenceFloat(name):
335 setting = getPreference(name).replace(',', '.')
336 return float(eval(setting, {}, {}))
337 except (ValueError, SyntaxError, TypeError):
340 def getPreferenceColour(name):
341 colorString = getPreference(name)
342 return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
344 def getPreference(name):
345 if name in tempOverride:
346 return unicode(tempOverride[name])
347 global globalPreferenceParser
348 if globalPreferenceParser == None:
349 globalPreferenceParser = ConfigParser.ConfigParser()
350 globalPreferenceParser.read(getPreferencePath())
351 if not globalPreferenceParser.has_option('preference', name):
352 if name in preferencesDefaultSettings:
353 default = preferencesDefaultSettings[name]
355 print("Missing default setting for: '" + name + "'")
356 preferencesDefaultSettings[name] = ''
358 if not globalPreferenceParser.has_section('preference'):
359 globalPreferenceParser.add_section('preference')
360 globalPreferenceParser.set('preference', name, str(default))
361 #print(name + " not found in preferences, so using default: " + str(default))
363 return unicode(globalPreferenceParser.get('preference', name), "utf-8")
365 def putPreference(name, value):
366 #Check if we have a configuration file loaded, else load the default.
367 global globalPreferenceParser
368 if globalPreferenceParser == None:
369 globalPreferenceParser = ConfigParser.ConfigParser()
370 globalPreferenceParser.read(getPreferencePath())
371 if not globalPreferenceParser.has_section('preference'):
372 globalPreferenceParser.add_section('preference')
373 globalPreferenceParser.set('preference', name, unicode(value).encode("utf-8"))
374 globalPreferenceParser.write(open(getPreferencePath(), 'w'))
376 def isPreference(name):
377 if name in preferencesDefaultSettings:
381 ## Temp overrides for multi-extruder slicing and the project planner.
383 def setTempOverride(name, value):
384 tempOverride[name] = unicode(value).encode("utf-8")
385 def clearTempOverride(name):
386 del tempOverride[name]
387 def resetTempOverride():
390 #########################################################
391 ## Utility functions to calculate common profile values
392 #########################################################
393 def calculateEdgeWidth():
394 wallThickness = getProfileSettingFloat('wall_thickness')
395 nozzleSize = getProfileSettingFloat('nozzle_size')
397 if wallThickness < nozzleSize:
400 lineCount = int(wallThickness / nozzleSize)
401 lineWidth = wallThickness / lineCount
402 lineWidthAlt = wallThickness / (lineCount + 1)
403 if lineWidth > nozzleSize * 1.5:
407 def calculateLineCount():
408 wallThickness = getProfileSettingFloat('wall_thickness')
409 nozzleSize = getProfileSettingFloat('nozzle_size')
411 if wallThickness < nozzleSize:
414 lineCount = int(wallThickness / nozzleSize + 0.0001)
415 lineWidth = wallThickness / lineCount
416 lineWidthAlt = wallThickness / (lineCount + 1)
417 if lineWidth > nozzleSize * 1.5:
421 def calculateSolidLayerCount():
422 layerHeight = getProfileSettingFloat('layer_height')
423 solidThickness = getProfileSettingFloat('solid_layer_thickness')
424 return int(math.ceil(solidThickness / layerHeight - 0.0001))
426 #########################################################
427 ## Alteration file functions
428 #########################################################
429 def replaceTagMatch(m):
433 return pre + time.strftime('%H:%M:%S').encode('utf-8', 'replace')
435 return pre + time.strftime('%d %b %Y').encode('utf-8', 'replace')
437 return pre + time.strftime('%a').encode('utf-8', 'replace')
438 if tag == 'print_time':
439 return pre + '#P_TIME#'
440 if tag == 'filament_amount':
441 return pre + '#F_AMNT#'
442 if tag == 'filament_weight':
443 return pre + '#F_WGHT#'
444 if tag == 'filament_cost':
445 return pre + '#F_COST#'
446 if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
447 f = getProfileSettingFloat(tag) * 60
448 elif isProfileSetting(tag):
449 f = getProfileSettingFloat(tag)
450 elif isPreference(tag):
451 f = getProfileSettingFloat(tag)
453 return '%s?%s?' % (pre, tag)
455 return pre + str(int(f))
458 def replaceGCodeTags(filename, gcodeInt):
459 f = open(filename, 'r+')
461 data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
462 data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
463 data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
464 cost = gcodeInt.calculateCost()
467 data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
472 ### Get aleration raw contents. (Used internally in Cura)
473 def getAlterationFile(filename):
474 #Check if we have a configuration file loaded, else load the default.
475 if not globals().has_key('globalProfileParser'):
476 loadGlobalProfile(getDefaultProfilePath())
478 if not globalProfileParser.has_option('alterations', filename):
479 if filename in alterationDefault:
480 default = alterationDefault[filename]
482 print("Missing default alteration for: '" + filename + "'")
483 alterationDefault[filename] = ''
485 if not globalProfileParser.has_section('alterations'):
486 globalProfileParser.add_section('alterations')
487 #print("Using default for: %s" % (filename))
488 globalProfileParser.set('alterations', filename, default)
489 return unicode(globalProfileParser.get('alterations', filename), "utf-8")
491 def setAlterationFile(filename, value):
492 #Check if we have a configuration file loaded, else load the default.
493 if not globals().has_key('globalProfileParser'):
494 loadGlobalProfile(getDefaultProfilePath())
495 if not globalProfileParser.has_section('alterations'):
496 globalProfileParser.add_section('alterations')
497 globalProfileParser.set('alterations', filename, value.encode("utf-8"))
498 saveGlobalProfile(getDefaultProfilePath())
500 ### Get the alteration file for output. (Used by Skeinforge)
501 def getAlterationFileContents(filename):
504 alterationContents = getAlterationFile(filename)
505 if filename == 'start.gcode':
506 #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.
507 #We also set our steps per E here, if configured.
508 eSteps = getPreferenceFloat('steps_per_e')
510 prefix += 'M92 E%f\n' % (eSteps)
511 temp = getProfileSettingFloat('print_temperature')
513 if getPreference('has_heated_bed') == 'True':
514 bedTemp = getProfileSettingFloat('print_bed_temperature')
516 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
517 prefix += 'M140 S%f\n' % (bedTemp)
518 if temp > 0 and not '{print_temperature}' in alterationContents:
519 prefix += 'M109 S%f\n' % (temp)
520 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
521 prefix += 'M190 S%f\n' % (bedTemp)
522 elif filename == 'end.gcode':
523 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
524 postfix = ';CURA_PROFILE_STRING:%s\n' % (getGlobalProfileString())
525 elif filename == 'replace.csv':
526 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.
527 prefix = 'M101\nM103\n'
528 elif filename == 'support_start.gcode' or filename == 'support_end.gcode':
529 #Add support start/end code
530 if getProfileSetting('support_dual_extrusion') == 'True' and int(getPreference('extruder_amount')) > 1:
531 if filename == 'support_start.gcode':
532 setTempOverride('extruder', '1')
534 setTempOverride('extruder', '0')
535 alterationContents = getAlterationFileContents('switchExtruder.gcode')
536 clearTempOverride('extruder')
538 alterationContents = ''
539 return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8')
543 def getPluginConfig():
545 return pickle.loads(getProfileSetting('plugin_config'))
549 def setPluginConfig(config):
550 putProfileSetting('plugin_config', pickle.dumps(config))
552 def getPluginBasePaths():
554 if platform.system() != "Windows":
555 ret.append(os.path.expanduser('~/.cura/plugins/'))
556 if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
557 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
559 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
564 for basePath in getPluginBasePaths():
565 for filename in glob.glob(os.path.join(basePath, '*.py')):
566 filename = os.path.basename(filename)
567 if filename.startswith('_'):
569 with open(os.path.join(basePath, filename), "r") as f:
570 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
573 if not line.startswith('#'):
575 line = line[1:].split(':', 1)
578 if line[0].upper() == 'NAME':
579 item['name'] = line[1].strip()
580 elif line[0].upper() == 'INFO':
581 item['info'] = line[1].strip()
582 elif line[0].upper() == 'TYPE':
583 item['type'] = line[1].strip()
584 elif line[0].upper() == 'DEPEND':
586 elif line[0].upper() == 'PARAM':
587 m = re.match('([a-zA-Z]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
589 item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
591 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
592 if item['name'] != None and item['type'] == 'postprocess':
596 def runPostProcessingPlugins(gcodefilename):
597 pluginConfigList = getPluginConfig()
598 pluginList = getPluginList()
600 for pluginConfig in pluginConfigList:
602 for pluginTest in pluginList:
603 if pluginTest['filename'] == pluginConfig['filename']:
609 for basePath in getPluginBasePaths():
610 testFilename = os.path.join(basePath, pluginConfig['filename'])
611 if os.path.isfile(testFilename):
612 pythonFile = testFilename
613 if pythonFile is None:
616 locals = {'filename': gcodefilename}
617 for param in plugin['params']:
618 value = param['default']
619 if param['name'] in pluginConfig['params']:
620 value = pluginConfig['params'][param['name']]
622 if param['type'] == 'float':
626 value = float(param['default'])
628 locals[param['name']] = value
630 execfile(pythonFile, locals)
632 locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
633 return "%s: '%s' @ %s:%s:%d" % (str(sys.exc_info()[0].__name__), str(sys.exc_info()[1]), os.path.basename(locationInfo[0]), locationInfo[2], locationInfo[1])
636 def getSDcardDrives():
638 if platform.system() == "Windows":
639 from ctypes import windll
640 bitmask = windll.kernel32.GetLogicalDrives()
641 for letter in string.uppercase:
643 drives.append(letter + ':/')
645 if platform.system() == "Darwin":
647 for volume in glob.glob('/Volumes/*'):
648 if stat.S_ISLNK(os.lstat(volume).st_mode):
650 drives.append(volume)