chiark / gitweb /
Add a minimal extrusion amount before allowing retraction to avoid flattening the...
[cura.git] / Cura / util / profile.py
1 from __future__ import absolute_import
2 from __future__ import division
3 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
4
5 import os, traceback, math, re, zlib, base64, time, sys, platform, glob, string, stat, types
6 import cPickle as pickle
7 if sys.version_info[0] < 3:
8         import ConfigParser
9 else:
10         import configparser as ConfigParser
11
12 from Cura.util import resources
13 from Cura.util import version
14 from Cura.util import validators
15
16 settingsDictionary = {}
17 settingsList = []
18 class setting(object):
19         def __init__(self, name, default, type, category, subcategory):
20                 self._name = name
21                 self._label = name
22                 self._tooltip = ''
23                 self._default = unicode(default)
24                 self._value = self._default
25                 self._type = type
26                 self._category = category
27                 self._subcategory = subcategory
28                 self._validators = []
29                 self._conditions = []
30
31                 if type is types.FloatType:
32                         validators.validFloat(self)
33                 elif type is types.IntType:
34                         validators.validInt(self)
35
36                 global settingsDictionary
37                 settingsDictionary[name] = self
38                 global settingsList
39                 settingsList.append(self)
40
41         def setLabel(self, label, tooltip = ''):
42                 self._label = label
43                 self._tooltip = tooltip
44                 return self
45
46         def setRange(self, minValue = None, maxValue = None):
47                 if len(self._validators) < 1:
48                         return
49                 self._validators[0].minValue = minValue
50                 self._validators[0].maxValue = maxValue
51                 return self
52
53         def getLabel(self):
54                 return self._label
55
56         def getTooltip(self):
57                 return self._tooltip
58
59         def getCategory(self):
60                 return self._category
61
62         def getSubCategory(self):
63                 return self._subcategory
64
65         def isPreference(self):
66                 return self._category == 'preference'
67
68         def isAlteration(self):
69                 return self._category == 'alteration'
70
71         def isProfile(self):
72                 return not self.isAlteration() and not self.isPreference()
73
74         def getName(self):
75                 return self._name
76
77         def getType(self):
78                 return self._type
79
80         def getValue(self):
81                 return self._value
82
83         def getDefault(self):
84                 return self._default
85
86         def setValue(self, value):
87                 self._value = unicode(value)
88
89         def validate(self):
90                 result = validators.SUCCESS
91                 msgs = []
92                 for validator in self._validators:
93                         res, err = validator.validate()
94                         if res == validators.ERROR:
95                                 result = res
96                         elif res == validators.WARNING and result != validators.ERROR:
97                                 result = res
98                         if res != validators.SUCCESS:
99                                 msgs.append(err)
100                 return result, '\n'.join(msgs)
101
102         def addCondition(self, conditionFunction):
103                 self._conditions.append(conditionFunction)
104
105         def checkConditions(self):
106                 for condition in self._conditions:
107                         if not condition():
108                                 return False
109                 return True
110
111 #########################################################
112 ## Settings
113 #########################################################
114 setting('layer_height',              0.1, float, 'basic',    'Quality').setRange(0.0001).setLabel('Layer height (mm)', 'Layer height in millimeters.\nThis is the most important setting to determen the quality of your print. Normal quality prints are 0.1mm, high quality is 0.06mm. You can go up to 0.25mm with an Ultimaker for very fast prints at low quality.')
115 setting('wall_thickness',            0.8, float, 'basic',    'Quality').setRange(0.0).setLabel('Shell thickness (mm)', 'Thickness of the outside shell in the horizontal direction.\nThis is used in combination with the nozzle size to define the number\nof perimeter lines and the thickness of those perimeter lines.')
116 setting('retraction_enable',       False, bool,  'basic',    'Quality').setLabel('Enable retraction', 'Retract the filament when the nozzle is moving over a none-printed area. Details about the retraction can be configured in the advanced tab.')
117 setting('solid_layer_thickness',     0.6, float, 'basic',    'Fill').setRange(0).setLabel('Bottom/Top thickness (mm)', 'This controls the thickness of the bottom and top layers, the amount of solid layers put down is calculated by the layer thickness and this value.\nHaving this value a multiply of the layer thickness makes sense. And keep it near your wall thickness to make an evenly strong part.')
118 setting('fill_density',               20, float, 'basic',    'Fill').setRange(0, 100).setLabel('Fill Density (%)', 'This controls how densely filled the insides of your print will be. For a solid part use 100%, for an empty part use 0%. A value around 20% is usually enough.\nThis won\'t effect the outside of the print and only adjusts how strong the part becomes.')
119 setting('nozzle_size',               0.4, float, 'advanced', 'Machine').setRange(0.1,10).setLabel('Nozzle size (mm)', 'The nozzle size is very important, this is used to calculate the line width of the infill, and used to calculate the amount of outside wall lines and thickness for the wall thickness you entered in the print settings.')
120 setting('print_speed',                50, float, 'basic',    'Speed & Temperature').setRange(1).setLabel('Print speed (mm/s)', 'Speed at which printing happens. A well adjusted Ultimaker can reach 150mm/s, but for good quality prints you want to print slower. Printing speed depends on a lot of factors. So you will be experimenting with optimal settings for this.')
121 setting('print_temperature',         220, int,   'basic',    'Speed & Temperature').setRange(0,340).setLabel('Printing temperature (C)', 'Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required.')
122 setting('print_temperature2',          0, int,   'basic',    'Speed & Temperature').setRange(0,340).setLabel('2nd nozzle temperature (C)', 'Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required.')
123 setting('print_temperature3',          0, int,   'basic',    'Speed & Temperature').setRange(0,340).setLabel('3th nozzle temperature (C)', 'Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required.')
124 setting('print_temperature4',          0, int,   'basic',    'Speed & Temperature').setRange(0,340).setLabel('4th nozzle temperature (C)', 'Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required.')
125 setting('print_bed_temperature',      70, int,   'basic',    'Speed & Temperature').setRange(0,340).setLabel('Bed temperature (C)', 'Temperature used for the heated printer bed. Set at 0 to pre-heat yourself.')
126 setting('support',                'None', ['None', 'Touching buildplate', 'Everywhere'], 'basic', 'Support').setLabel('Support type', 'Type of support structure build.\n"Touching buildplate" is the most commonly used support setting.\n\nNone does not do any support.\nTouching buildplate only creates support where the support structure will touch the build platform.\nEverywhere creates support even on top of parts of the model.')
127 setting('platform_adhesion',      'None', ['None', 'Brim', 'Raft'], 'basic', 'Support').setLabel('Platform adhesion type', 'Different options that help in preventing corners from lifting due to warping.\nBrim adds a single layer thick flat area around your object which is easy to cut off afterwards, and the recommended option.\nRaft adds a thick raster at below the object and a thin interface between this and your object.\n(Note that enabling the brim or raft disables the skirt)')
128 setting('support_dual_extrusion',  False, bool, 'basic', 'Support').setLabel('Support dual extrusion', 'Print the support material with the 2nd extruder in a dual extrusion setup. The primary extruder will be used for normal material, while the second extruder is used to print support material.')
129 setting('filament_diameter',        2.85, float, 'basic',    'Filament').setRange(1).setLabel('Diameter (mm)', 'Diameter of your filament, as accurately as possible.\nIf you cannot measure this value you will have to calibrate it, a higher number means less extrusion, a smaller number generates more extrusion.')
130 setting('filament_diameter2',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter2 (mm)', 'Diameter of your filament for the 2nd nozzle. Use 0 to use the same diameter as for nozzle 1.')
131 setting('filament_diameter3',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter3 (mm)', 'Diameter of your filament for the 3th nozzle. Use 0 to use the same diameter as for nozzle 1.')
132 setting('filament_diameter4',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter4 (mm)', 'Diameter of your filament for the 4th nozzle. Use 0 to use the same diameter as for nozzle 1.')
133 setting('filament_flow',            100., float, 'basic',    'Filament').setRange(1,300).setLabel('Flow (%)', 'Flow compensation, the amount of material extruded is multiplied by this value')
134 setting('retraction_speed',         40.0, float, 'advanced', 'Retraction').setRange(0.1).setLabel('Speed (mm/s)', 'Speed at which the filament is retracted, a higher retraction speed works better. But a very high retraction speed can lead to filament grinding.')
135 setting('retraction_amount',         4.5, float, 'advanced', 'Retraction').setRange(0).setLabel('Distance (mm)', 'Amount of retraction, set at 0 for no retraction at all. A value of 4.5mm seems to generate good results.')
136 setting('retraction_dual_amount',   16.5, float, 'advanced', 'Retraction').setRange(0).setLabel('Dual extrusion switch amount (mm)', 'Amount of retraction when switching nozzle with dual-extrusion, set at 0 for no retraction at all. A value of 16.0mm seems to generate good results.')
137 setting('retraction_min_travel',     1.5, float, 'expert',   'Retraction').setRange(0).setLabel('Minimum travel (mm)', 'Minimum amount of travel needed for a retraction to happen at all. To make sure you do not get a lot of retractions in a small area.')
138 setting('retraction_combing',       True, bool,  'expert',   'Retraction').setLabel('Enable combing', 'Combing is the act of avoiding holes in the print for the head to travel over. If combing is disabled the printer head moves straight from the start point to the end point and it will always retract.')
139 setting('retraction_minimal_extrusion',0.5, float,'expert',  'Retraction').setRange(0).setLabel('Minimal extrusion before retracting (mm)', 'The minimal amount of extrusion that needs to be done before retracting again if a retraction needs to happen before this minimal is reached the retraction is ignored.\nThis avoids retraction a lot on the same piece of filament which flattens the filament and causes grinding issues.')
140 setting('bottom_thickness',          0.3, float, 'advanced', 'Quality').setRange(0).setLabel('Initial layer thickness (mm)', 'Layer thickness of the bottom layer. A thicker bottom layer makes sticking to the bed easier. Set to 0.0 to have the bottom layer thickness the same as the other layers.')
141 setting('object_sink',               0.0, float, 'advanced', 'Quality').setLabel('Cut off object bottom (mm)', 'Sinks the object into the platform, this can be used for objects that do not have a flat bottom and thus create a too small first layer.')
142 #setting('enable_skin',             False, bool,  'advanced', 'Quality').setLabel('Duplicate outlines', 'Skin prints the outer lines of the prints twice, each time with half the thickness. This gives the illusion of a higher print quality.')
143 setting('overlap_dual',              0.2, float, 'advanced', 'Quality').setLabel('Dual extrusion overlap (mm)', 'Add a certain amount of overlapping extrusion on dual-extrusion prints. This bonds the different colors better together.')
144 setting('travel_speed',            150.0, float, 'advanced', 'Speed').setRange(0.1).setLabel('Travel speed (mm/s)', 'Speed at which travel moves are done, a high quality build Ultimaker can reach speeds of 250mm/s. But some machines might miss steps then.')
145 setting('bottom_layer_speed',         20, float, 'advanced', 'Speed').setRange(0.1).setLabel('Bottom layer speed (mm/s)', 'Print speed for the bottom layer, you want to print the first layer slower so it sticks better to the printer bed.')
146 setting('infill_speed',              0.0, float, 'advanced', 'Speed').setRange(0.0).setLabel('Infill speed (mm/s)', 'Speed at which infill parts are printed. If set to 0 then the print speed is used for the infill. Printing the infill faster can greatly reduce printing, but this can negatively effect print quality..')
147 setting('cool_min_layer_time',         5, float, 'advanced', 'Cool').setRange(0).setLabel('Minimal layer time (sec)', 'Minimum time spend in a layer, gives the layer time to cool down before the next layer is put on top. If the layer will be placed down too fast the printer will slow down to make sure it has spend at least this amount of seconds printing this layer.')
148 setting('fan_enabled',              True, bool,  'advanced', 'Cool').setLabel('Enable cooling fan', 'Enable the cooling fan during the print. The extra cooling from the cooling fan is essential during faster prints.')
149
150 setting('skirt_line_count',            1, int,   'expert', 'Skirt').setRange(0).setLabel('Line count', 'The skirt is a line drawn around the object at the first layer. This helps to prime your extruder, and to see if the object fits on your platform.\nSetting this to 0 will disable the skirt. Multiple skirt lines can help priming your extruder better for small objects.')
151 setting('skirt_gap',                 3.0, float, 'expert', 'Skirt').setRange(0).setLabel('Start distance (mm)', 'The distance between the skirt and the first layer.\nThis is the minimal distance, multiple skirt lines will be put outwards from this distance.')
152 #setting('max_z_speed',               3.0, float, 'expert',   'Speed').setRange(0.1).setLabel('Max Z speed (mm/s)', 'Speed at which Z moves are done. When you Z axis is properly lubricated you can increase this for less Z blob.')
153 #setting('retract_on_jumps_only',    True, bool,  'expert',   'Retraction').setLabel('Retract on jumps only', 'Only retract when we are making a move that is over a hole in the model, else retract on every move. This effects print quality in different ways.')
154 setting('fan_layer',                   1, int,   'expert',   'Cool').setRange(0).setLabel('Fan on layer number', 'The layer at which the fan is turned on. The first layer is layer 0. The first layer can stick better if you turn on the fan on, on the 2nd layer.')
155 setting('fan_speed',                 100, int,   'expert',   'Cool').setRange(0,100).setLabel('Fan speed min (%)', 'When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Minimal fan speed is used if the layer is not slowed down due to cooling.')
156 setting('fan_speed_max',             100, int,   'expert',   'Cool').setRange(0,100).setLabel('Fan speed max (%)', 'When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Maximal fan speed is used if the layer is slowed down due to cooling by more than 200%.')
157 setting('cool_min_feedrate',          10, float, 'expert',   'Cool').setRange(0).setLabel('Minimum speed (mm/s)', 'The minimal layer time can cause the print to slow down so much it starts to ooze. The minimal feedrate protects against this. Even if a print gets slown down it will never be slower than this minimal speed.')
158 setting('cool_head_lift',          False, bool,  'expert',   'Cool').setLabel('Cool head lift', 'Lift the head if the minimal speed is hit because of cool slowdown, and wait the extra time so the minimal layer time is always hit.')
159 #setting('extra_base_wall_thickness', 0.0, float, 'expert',   'Accuracy').setRange(0).setLabel('Extra Wall thickness for bottom/top (mm)', 'Additional wall thickness of the bottom and top layers.')
160 #setting('sequence', 'Loops > Perimeter > Infill', ['Loops > Perimeter > Infill', 'Loops > Infill > Perimeter', 'Infill > Loops > Perimeter', 'Infill > Perimeter > Loops', 'Perimeter > Infill > Loops', 'Perimeter > Loops > Infill'], 'expert', 'Sequence')
161 #setting('force_first_layer_sequence', True, bool, 'expert', 'Sequence').setLabel('Force first layer sequence', 'This setting forces the order of the first layer to be \'Perimeter > Loops > Infill\'')
162 #setting('infill_type', 'Line', ['Line', 'Grid Circular', 'Grid Hexagonal', 'Grid Rectangular'], 'expert', 'Infill').setLabel('Infill pattern', 'Pattern of the none-solid infill. Line is default, but grids can provide a strong print.')
163 setting('solid_top', True, bool, 'expert', 'Infill').setLabel('Solid infill top', 'Create a solid top surface, if set to false the top is filled with the fill percentage. Useful for cups/vases.')
164 setting('solid_bottom', True, bool, 'expert', 'Infill').setLabel('Solid infill bottom', 'Create a solid bottom surface, if set to false the bottom is filled with the fill percentage. Useful for buildings.')
165 setting('fill_overlap', 15, int, 'expert', 'Infill').setRange(0,100).setLabel('Infill overlap (%)', 'Amount of overlap between the infill and the walls. There is a slight overlap with the walls and the infill so the walls connect firmly to the infill.')
166 setting('support_rate', 75, int, 'expert', 'Support').setRange(0,100).setLabel('Material amount (%)', 'Amount of material used for support, less material gives a weaker support structure which is easier to remove.')
167 #setting('support_distance',  0.5, float, 'expert', 'Support').setRange(0).setLabel('Distance from object (mm)', 'Distance between the support structure and the object. Empty gap in which no support structure is printed.')
168 #setting('joris', False, bool, 'expert', 'Joris').setLabel('Spiralize the outer contour', '[Joris] is a code name for smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. It is intended to be used with a single walled wall thickness to make cups/vases.')
169 #setting('bridge_speed', 100, int, 'expert', 'Bridge').setRange(0,100).setLabel('Bridge speed (%)', 'Speed at which layers with bridges are printed, compared to normal printing speed.')
170 setting('brim_line_count', 20, int, 'expert', 'Brim').setRange(1,100).setLabel('Brim line amount', 'The amount of lines used for a brim, more lines means a larger brim which sticks better, but this also makes your effective print area smaller.')
171 setting('raft_margin', 5, float, 'expert', 'Raft').setRange(0).setLabel('Extra margin (mm)', 'If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft while using more material and leaving less are for your print.')
172 setting('raft_line_spacing', 1.0, float, 'expert', 'Raft').setRange(0).setLabel('Line spacing (mm)', 'When you are using the raft this is the distance between the centerlines of the raft line.')
173 setting('raft_base_thickness', 0.3, float, 'expert', 'Raft').setRange(0).setLabel('Base thickness (mm)', 'When you are using the raft this is the thickness of the base layer which is put down.')
174 setting('raft_base_linewidth', 0.7, float, 'expert', 'Raft').setRange(0).setLabel('Base line width (mm)', 'When you are using the raft this is the width of the base layer lines which are put down.')
175 setting('raft_interface_thickness', 0.2, float, 'expert', 'Raft').setRange(0).setLabel('Interface thickness (mm)', 'When you are using the raft this is the thickness of the interface layer which is put down.')
176 setting('raft_interface_linewidth', 0.2, float, 'expert', 'Raft').setRange(0).setLabel('Interface line width (mm)', 'When you are using the raft this is the width of the interface layer lines which are put down.')
177 #setting('hop_on_move', False, bool, 'expert', 'Hop').setLabel('Enable hop on move', 'When moving from print position to print position, raise the printer head 0.2mm so it does not knock off the print (experimental).')
178 setting('fix_horrible_union_all_type_a', False, bool, 'expert', 'Fix horrible').setLabel('Combine everything (Type-A)', 'This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer.')
179 setting('fix_horrible_union_all_type_b', False, bool, 'expert', 'Fix horrible').setLabel('Combine everything (Type-B)', 'This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer.')
180 setting('fix_horrible_use_open_bits', False, bool, 'expert', 'Fix horrible').setLabel('Keep open faces', 'This expert option keeps all the open bits of the model intact. Normally Cura tries to stitch up small holes and remove everything with big holes, but this option keeps bits that are not properly part of anything and just goes with whatever it is left. This option is usually not what you want, but it might enable you to slice models otherwise failing to produce proper paths.\nAs with all "Fix horrible" options, results may vary and use at your own risk.')
181 setting('fix_horrible_extensive_stitching', False, bool, 'expert', 'Fix horrible').setLabel('Extensive stitching', 'Extrensive stitching tries to fix up open holes in the model by closing the hole with touching polygons. This algorthm is quite expensive and could introduce a lot of processing time.\nAs with all "Fix horrible" options, results may vary and use at your own risk.')
182
183 setting('plugin_config', '', str, 'hidden', 'hidden')
184 setting('object_center_x', -1, float, 'hidden', 'hidden')
185 setting('object_center_y', -1, float, 'hidden', 'hidden')
186
187 setting('start.gcode', """;Sliced at: {day} {date} {time}
188 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
189 ;Print time: {print_time}
190 ;Filament used: {filament_amount}m {filament_weight}g
191 ;Filament cost: {filament_cost}
192 G21        ;metric values
193 G90        ;absolute positioning
194 M107       ;start with the fan off
195
196 G28 X0 Y0  ;move X/Y to min endstops
197 G28 Z0     ;move Z to min endstops
198
199 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
200
201 G92 E0                  ;zero the extruded length
202 G1 F200 E3              ;extrude 3mm of feed stock
203 G92 E0                  ;zero the extruded length again
204 G1 F{travel_speed}
205 M117 Printing...
206 """, str, 'alteration', 'alteration')
207 #######################################################################################
208 setting('end.gcode', """;End GCode
209 M104 S0                     ;extruder heater off
210 M140 S0                     ;heated bed heater off (if you have it)
211
212 G91                                    ;relative positioning
213 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
214 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
215 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
216
217 M84                         ;steppers off
218 G90                         ;absolute positioning
219 """, str, 'alteration', 'alteration')
220 #######################################################################################
221 setting('start2.gcode', """;Sliced at: {day} {date} {time}
222 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
223 ;Print time: {print_time}
224 ;Filament used: {filament_amount}m {filament_weight}g
225 ;Filament cost: {filament_cost}
226 G21        ;metric values
227 G90        ;absolute positioning
228 M107       ;start with the fan off
229
230 G28 X0 Y0  ;move X/Y to min endstops
231 G28 Z0     ;move Z to min endstops
232
233 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
234
235 T1
236 G92 E0                  ;zero the extruded length
237 G1 F200 E10             ;extrude 10mm of feed stock
238 G92 E0                  ;zero the extruded length again
239 G1 F200 E-{retraction_dual_amount}
240
241 T0
242 G92 E0                  ;zero the extruded length
243 G1 F200 E10              ;extrude 10mm of feed stock
244 G92 E0                  ;zero the extruded length again
245 G1 F{travel_speed}
246 M117 Printing...
247 """, str, 'alteration', 'alteration')
248 #######################################################################################
249 setting('end2.gcode', """;End GCode
250 M104 T0 S0                     ;extruder heater off
251 M104 T1 S0                     ;extruder heater off
252 M140 S0                     ;heated bed heater off (if you have it)
253
254 G91                                    ;relative positioning
255 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
256 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
257 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
258
259 M84                         ;steppers off
260 G90                         ;absolute positioning
261 """, str, 'alteration', 'alteration')
262 #######################################################################################
263 setting('support_start.gcode', '', str, 'alteration', 'alteration')
264 setting('support_end.gcode', '', str, 'alteration', 'alteration')
265 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
266 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
267 setting('replace.csv', '', str, 'alteration', 'alteration')
268 #######################################################################################
269 setting('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.
270 G92 E0
271
272 G91                                    ;relative positioning
273 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
274 G1 Z+0.5 E-5 F{travel_speed}           ;move Z up a bit and retract filament even more
275 G90                                    ;absolute positioning
276
277 G1 Z{clear_z} F{max_z_speed}
278 G92 E0
279 G1 X{object_center_x} Y{object_center_y} F{travel_speed}
280 G1 F200 E6
281 G92 E0
282 """, str, 'alteration', 'alteration')
283 #######################################################################################
284 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
285 G92 E0
286 G1 E-36 F5000
287 G92 E0
288 T{extruder}
289 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
290 G1 E36 F5000
291 G92 E0
292 """, str, 'alteration', 'alteration')
293
294 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
295 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
296 setting('machine_width', '205', float, 'preference', 'hidden').setLabel('Maximum width (mm)', 'Size of the machine in mm')
297 setting('machine_depth', '205', float, 'preference', 'hidden').setLabel('Maximum depth (mm)', 'Size of the machine in mm')
298 setting('machine_height', '200', float, 'preference', 'hidden').setLabel('Maximum height (mm)', 'Size of the machine in mm')
299 setting('machine_type', 'unknown', str, 'preference', 'hidden')
300 setting('machine_center_is_zero', 'False', bool, 'preference', 'hidden')
301 setting('ultimaker_extruder_upgrade', 'False', bool, 'preference', 'hidden')
302 setting('has_heated_bed', 'False', bool, 'preference', 'hidden').setLabel('Heated bed', 'If you have an heated bed, this enabled heated bed settings (requires restart)')
303 setting('machine_type', 'unknown', str, 'preference', 'hidden')
304 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode'], 'preference', 'hidden').setLabel('GCode Flavor', 'Flavor of generated GCode.\nRepRap...')
305 setting('extruder_amount', '1', ['1','2','3','4'], 'preference', 'hidden').setLabel('Extruder count', 'Amount of extruders in your machine.')
306 setting('extruder_offset_x1', '-21.6', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
307 setting('extruder_offset_y1', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
308 setting('extruder_offset_x2', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
309 setting('extruder_offset_y2', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
310 setting('extruder_offset_x3', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
311 setting('extruder_offset_y3', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
312 setting('filament_physical_density', '1240', float, 'preference', 'hidden').setRange(500.0, 3000.0).setLabel('Density (kg/m3)', 'Weight of the filament per m3. Around 1240 for PLA. And around 1040 for ABS. This value is used to estimate the weight if the filament used for the print.')
313 setting('steps_per_e', '0', float, 'preference', 'hidden').setLabel('E-Steps per 1mm filament', 'Amount of steps per mm filament extrusion. If set to 0 then this value is ignored and the value in your firmware is used.')
314 setting('serial_port', 'AUTO', str, 'preference', 'hidden').setLabel('Serial port', 'Serial port to use for communication with the printer')
315 setting('serial_port_auto', '', str, 'preference', 'hidden')
316 setting('serial_baud', 'AUTO', str, 'preference', 'hidden').setLabel('Baudrate', 'Speed of the serial port communication\nNeeds to match your firmware settings\nCommon values are 250000, 115200, 57600')
317 setting('serial_baud_auto', '', int, 'preference', 'hidden')
318 setting('save_profile', 'False', bool, 'preference', 'hidden').setLabel('Save profile on slice', 'When slicing save the profile as [stl_file]_profile.ini next to the model.')
319 setting('filament_cost_kg', '0', float, 'preference', 'hidden').setLabel('Cost (price/kg)', 'Cost of your filament per kg, to estimate the cost of the final print.')
320 setting('filament_cost_meter', '0', float, 'preference', 'hidden').setLabel('Cost (price/m)', 'Cost of your filament per meter, to estimate the cost of the final print.')
321 setting('auto_detect_sd', 'True', bool, 'preference', 'hidden').setLabel('Auto detect SD card drive', 'Auto detect the SD card. You can disable this because on some systems external hard-drives or USB sticks are detected as SD card.')
322 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
323 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
324
325 setting('extruder_head_size_min_x', '0.0', float, 'preference', 'hidden').setLabel('Head size towards X min (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 75mm for an Ultimaker if the fan is on the left side.')
326 setting('extruder_head_size_min_y', '0.0', float, 'preference', 'hidden').setLabel('Head size towards Y min (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 18mm for an Ultimaker if the fan is on the left side.')
327 setting('extruder_head_size_max_x', '0.0', float, 'preference', 'hidden').setLabel('Head size towards X max (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 18mm for an Ultimaker if the fan is on the left side.')
328 setting('extruder_head_size_max_y', '0.0', float, 'preference', 'hidden').setLabel('Head size towards Y max (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 35mm for an Ultimaker if the fan is on the left side.')
329 setting('extruder_head_size_height', '0.0', float, 'preference', 'hidden').setLabel('Printer gantry height (mm)', 'The height of the gantry holding up the printer head. If an object is higher then this then you cannot print multiple objects one for one. 60mm for an Ultimaker.')
330
331 setting('model_colour', '#7AB645', str, 'preference', 'hidden').setLabel('Model colour')
332 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
333 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
334 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
335
336 setting('window_maximized', 'True', bool, 'preference', 'hidden')
337 setting('window_pos_x', '-1', float, 'preference', 'hidden')
338 setting('window_pos_y', '-1', float, 'preference', 'hidden')
339 setting('window_width', '-1', float, 'preference', 'hidden')
340 setting('window_height', '-1', float, 'preference', 'hidden')
341 setting('window_normal_sash', '320', float, 'preference', 'hidden')
342
343 validators.warningAbove(settingsDictionary['filament_flow'], 150, "More flow then 150% is rare and usually not recommended.")
344 validators.warningBelow(settingsDictionary['filament_flow'], 50, "More flow then 50% is rare and usually not recommended.")
345 validators.warningAbove(settingsDictionary['layer_height'], lambda : (float(getProfileSetting('nozzle_size')) * 80.0 / 100.0), "Thicker layers then %.2fmm (80%% nozzle size) usually give bad results and are not recommended.")
346 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
347 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
348 validators.printSpeedValidator(settingsDictionary['print_speed'])
349 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
350 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
351 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
352 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
353 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
354 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
355 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
356 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
357 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
358 validators.warningAbove(settingsDictionary['bottom_thickness'], lambda : (float(getProfileSetting('nozzle_size')) * 3.0 / 4.0), "A bottom layer of more then %.2fmm (3/4 nozzle size) usually give bad results and is not recommended.")
359
360 #Conditions for multiple extruders
361 settingsDictionary['print_temperature2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
362 settingsDictionary['print_temperature3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
363 settingsDictionary['print_temperature4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
364 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
365 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
366 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
367 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
368 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
369 #Heated bed
370 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('has_heated_bed') == 'True')
371
372 #UltiGCode uses less settings
373 settingsDictionary['print_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
374 settingsDictionary['print_temperature2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
375 settingsDictionary['print_temperature3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
376 settingsDictionary['print_temperature4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
377 settingsDictionary['filament_diameter'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
378 settingsDictionary['filament_diameter2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
379 settingsDictionary['filament_diameter3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
380 settingsDictionary['filament_diameter4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
381 settingsDictionary['filament_flow'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
382 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
383 settingsDictionary['retraction_speed'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
384 settingsDictionary['retraction_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
385 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
386
387 #########################################################
388 ## Profile and preferences functions
389 #########################################################
390
391 def getSubCategoriesFor(category):
392         done = {}
393         ret = []
394         for s in settingsList:
395                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
396                         done[s.getSubCategory()] = True
397                         ret.append(s.getSubCategory())
398         return ret
399
400 def getSettingsForCategory(category, subCategory = None):
401         ret = []
402         for s in settingsList:
403                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
404                         ret.append(s)
405         return ret
406
407 ## Profile functions
408 def getBasePath():
409         if platform.system() == "Windows":
410                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
411                 #If we have a frozen python install, we need to step out of the library.zip
412                 if hasattr(sys, 'frozen'):
413                         basePath = os.path.normpath(os.path.join(basePath, ".."))
414         else:
415                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
416         if not os.path.isdir(basePath):
417                 os.makedirs(basePath)
418         return basePath
419
420 def getAlternativeBasePaths():
421         paths = []
422         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
423         for subPath in os.listdir(basePath):
424                 path = os.path.join(basePath, subPath)
425                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
426                         paths.append(path)
427                 path = os.path.join(basePath, subPath, 'Cura')
428                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
429                         paths.append(path)
430         return paths
431
432 def getDefaultProfilePath():
433         return os.path.join(getBasePath(), 'current_profile.ini')
434
435 def loadProfile(filename):
436         #Read a configuration file as global config
437         profileParser = ConfigParser.ConfigParser()
438         try:
439                 profileParser.read(filename)
440         except ConfigParser.ParsingError:
441                 return
442         global settingsList
443         for set in settingsList:
444                 if set.isPreference():
445                         continue
446                 section = 'profile'
447                 if set.isAlteration():
448                         section = 'alterations'
449                 if profileParser.has_option(section, set.getName()):
450                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
451
452 def saveProfile(filename):
453         #Save the current profile to an ini file
454         profileParser = ConfigParser.ConfigParser()
455         profileParser.add_section('profile')
456         profileParser.add_section('alterations')
457         global settingsList
458         for set in settingsList:
459                 if set.isPreference():
460                         continue
461                 if set.isAlteration():
462                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
463                 else:
464                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
465
466         profileParser.write(open(filename, 'w'))
467
468 def resetProfile():
469         #Read a configuration file as global config
470         global settingsList
471         for set in settingsList:
472                 if set.isPreference():
473                         continue
474                 set.setValue(set.getDefault())
475
476         if getPreference('machine_type') == 'ultimaker':
477                 putProfileSetting('nozzle_size', '0.4')
478                 if getPreference('ultimaker_extruder_upgrade') == 'True':
479                         putProfileSetting('retraction_enable', 'True')
480         else:
481                 putProfileSetting('nozzle_size', '0.5')
482
483 def loadProfileFromString(options):
484         options = base64.b64decode(options)
485         options = zlib.decompress(options)
486         (profileOpts, alt) = options.split('\f', 1)
487         global settingsDictionary
488         for option in profileOpts.split('\b'):
489                 if len(option) > 0:
490                         (key, value) = option.split('=', 1)
491                         if key in settingsDictionary:
492                                 if settingsDictionary[key].isProfile():
493                                         settingsDictionary[key].setValue(value)
494         for option in alt.split('\b'):
495                 if len(option) > 0:
496                         (key, value) = option.split('=', 1)
497                         if key in settingsDictionary:
498                                 if settingsDictionary[key].isAlteration():
499                                         settingsDictionary[key].setValue(value)
500
501 def getProfileString():
502         p = []
503         alt = []
504         global settingsList
505         for set in settingsList:
506                 if set.isProfile():
507                         if set.getName() in tempOverride:
508                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
509                         else:
510                                 p.append(set.getName() + "=" + set.getValue())
511                 if set.isAlteration():
512                         if set.getName() in tempOverride:
513                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
514                         else:
515                                 alt.append(set.getName() + "=" + set.getValue())
516         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
517         ret = base64.b64encode(zlib.compress(ret, 9))
518         return ret
519
520 def getGlobalPreferencesString():
521         p = []
522         global settingsList
523         for set in settingsList:
524                 if set.isPreference():
525                         p.append(set.getName() + "=" + set.getValue())
526         ret = '\b'.join(p)
527         ret = base64.b64encode(zlib.compress(ret, 9))
528         return ret
529
530
531 def getProfileSetting(name):
532         if name in tempOverride:
533                 return tempOverride[name]
534         global settingsDictionary
535         if name in settingsDictionary and settingsDictionary[name].isProfile():
536                 return settingsDictionary[name].getValue()
537         print 'Error: "%s" not found in profile settings' % (name)
538         return ''
539
540 def getProfileSettingFloat(name):
541         try:
542                 setting = getProfileSetting(name).replace(',', '.')
543                 return float(eval(setting, {}, {}))
544         except:
545                 return 0.0
546
547 def putProfileSetting(name, value):
548         #Check if we have a configuration file loaded, else load the default.
549         global settingsDictionary
550         if name in settingsDictionary and settingsDictionary[name].isProfile():
551                 settingsDictionary[name].setValue(value)
552
553 def isProfileSetting(name):
554         global settingsDictionary
555         if name in settingsDictionary and settingsDictionary[name].isProfile():
556                 return True
557         return False
558
559 ## Preferences functions
560 def getPreferencePath():
561         return os.path.join(getBasePath(), 'preferences.ini')
562
563 def getPreferenceFloat(name):
564         try:
565                 setting = getPreference(name).replace(',', '.')
566                 return float(eval(setting, {}, {}))
567         except:
568                 return 0.0
569
570 def getPreferenceColour(name):
571         colorString = getPreference(name)
572         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
573
574 def loadPreferences(filename):
575         #Read a configuration file as global config
576         profileParser = ConfigParser.ConfigParser()
577         try:
578                 profileParser.read(filename)
579         except ConfigParser.ParsingError:
580                 return
581         global settingsList
582         for set in settingsList:
583                 if set.isPreference():
584                         if profileParser.has_option('preference', set.getName()):
585                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
586
587 def savePreferences(filename):
588         #Save the current profile to an ini file
589         parser = ConfigParser.ConfigParser()
590         parser.add_section('preference')
591         global settingsList
592         for set in settingsList:
593                 if set.isPreference():
594                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
595         parser.write(open(filename, 'w'))
596
597 def getPreference(name):
598         if name in tempOverride:
599                 return tempOverride[name]
600         global settingsDictionary
601         if name in settingsDictionary and settingsDictionary[name].isPreference():
602                 return settingsDictionary[name].getValue()
603         print 'Error: "%s" not found in profile settings' % (name)
604         return ''
605
606 def putPreference(name, value):
607         #Check if we have a configuration file loaded, else load the default.
608         global settingsDictionary
609         if name in settingsDictionary and settingsDictionary[name].isPreference():
610                 settingsDictionary[name].setValue(value)
611         savePreferences(getPreferencePath())
612
613 def isPreference(name):
614         global settingsDictionary
615         if name in settingsDictionary and settingsDictionary[name].isPreference():
616                 return True
617         return False
618
619 ## Temp overrides for multi-extruder slicing and the project planner.
620 tempOverride = {}
621 def setTempOverride(name, value):
622         tempOverride[name] = unicode(value).encode("utf-8")
623 def clearTempOverride(name):
624         del tempOverride[name]
625 def resetTempOverride():
626         tempOverride.clear()
627
628 #########################################################
629 ## Utility functions to calculate common profile values
630 #########################################################
631 def calculateEdgeWidth():
632         wallThickness = getProfileSettingFloat('wall_thickness')
633         nozzleSize = getProfileSettingFloat('nozzle_size')
634
635         if wallThickness < 0.01:
636                 return nozzleSize
637         if wallThickness < nozzleSize:
638                 return wallThickness
639
640         lineCount = int(wallThickness / (nozzleSize + 0.0001))
641         lineWidth = wallThickness / lineCount
642         lineWidthAlt = wallThickness / (lineCount + 1)
643         if lineWidth > nozzleSize * 1.5:
644                 return lineWidthAlt
645         return lineWidth
646
647 def calculateLineCount():
648         wallThickness = getProfileSettingFloat('wall_thickness')
649         nozzleSize = getProfileSettingFloat('nozzle_size')
650
651         if wallThickness < 0.01:
652                 return 0
653         if wallThickness < nozzleSize:
654                 return 1
655
656         lineCount = int(wallThickness / (nozzleSize + 0.0001))
657         lineWidth = wallThickness / lineCount
658         lineWidthAlt = wallThickness / (lineCount + 1)
659         if lineWidth > nozzleSize * 1.5:
660                 return lineCount + 1
661         return lineCount
662
663 def calculateSolidLayerCount():
664         layerHeight = getProfileSettingFloat('layer_height')
665         solidThickness = getProfileSettingFloat('solid_layer_thickness')
666         if layerHeight == 0.0:
667                 return 1
668         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
669
670 def calculateObjectSizeOffsets():
671         size = 0.0
672
673         if getProfileSetting('platform_adhesion') == 'Brim':
674                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
675         elif getProfileSetting('platform_adhesion') == 'Raft':
676                 pass
677         else:
678                 if getProfileSettingFloat('skirt_line_count') > 0:
679                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
680
681         #if getProfileSetting('enable_raft') != 'False':
682         #       size += profile.getProfileSettingFloat('raft_margin') * 2
683         #if getProfileSetting('support') != 'None':
684         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
685         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
686         return [size, size]
687
688 def getMachineCenterCoords():
689         if getPreference('machine_center_is_zero') == 'True':
690                 return [0, 0]
691         return [getPreferenceFloat('machine_width') / 2, getPreferenceFloat('machine_depth') / 2]
692
693 #########################################################
694 ## Alteration file functions
695 #########################################################
696 def replaceTagMatch(m):
697         pre = m.group(1)
698         tag = m.group(2)
699         if tag == 'time':
700                 return pre + time.strftime('%H:%M:%S').encode('ascii', 'replace')
701         if tag == 'date':
702                 return pre + time.strftime('%d %b %Y').encode('ascii', 'replace')
703         if tag == 'day':
704                 return pre + time.strftime('%a').encode('ascii', 'replace')
705         if tag == 'print_time':
706                 return pre + '#P_TIME#'
707         if tag == 'filament_amount':
708                 return pre + '#F_AMNT#'
709         if tag == 'filament_weight':
710                 return pre + '#F_WGHT#'
711         if tag == 'filament_cost':
712                 return pre + '#F_COST#'
713         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
714                 f = getProfileSettingFloat(tag) * 60
715         elif isProfileSetting(tag):
716                 f = getProfileSettingFloat(tag)
717         elif isPreference(tag):
718                 f = getProfileSettingFloat(tag)
719         else:
720                 return '%s?%s?' % (pre, tag)
721         if (f % 1) == 0:
722                 return pre + str(int(f))
723         return pre + str(f)
724
725 def replaceGCodeTags(filename, gcodeInt):
726         f = open(filename, 'r+')
727         data = f.read(2048)
728         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
729         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
730         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
731         cost = gcodeInt.calculateCost()
732         if cost is None:
733                 cost = 'Unknown'
734         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
735         f.seek(0)
736         f.write(data)
737         f.close()
738
739 ### Get aleration raw contents. (Used internally in Cura)
740 def getAlterationFile(filename):
741         if filename in tempOverride:
742                 return tempOverride[filename]
743         global settingsDictionary
744         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
745                 return settingsDictionary[filename].getValue()
746         print 'Error: "%s" not found in profile settings' % (filename)
747         return ''
748
749 def setAlterationFile(name, value):
750         #Check if we have a configuration file loaded, else load the default.
751         global settingsDictionary
752         if name in settingsDictionary and settingsDictionary[name].isAlteration():
753                 settingsDictionary[name].setValue(value)
754         saveProfile(getDefaultProfilePath())
755
756 ### Get the alteration file for output. (Used by Skeinforge)
757 def getAlterationFileContents(filename, extruderCount = 1):
758         prefix = ''
759         postfix = ''
760         alterationContents = getAlterationFile(filename)
761         if getPreference('gcode_flavor') == 'UltiGCode':
762                 return ''
763         if filename == 'start.gcode':
764                 if extruderCount > 1:
765                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
766                 #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.
767                 #We also set our steps per E here, if configured.
768                 eSteps = getPreferenceFloat('steps_per_e')
769                 if eSteps > 0:
770                         prefix += 'M92 E%f\n' % (eSteps)
771                 temp = getProfileSettingFloat('print_temperature')
772                 bedTemp = 0
773                 if getPreference('has_heated_bed') == 'True':
774                         bedTemp = getProfileSettingFloat('print_bed_temperature')
775                 
776                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
777                         prefix += 'M140 S%f\n' % (bedTemp)
778                 if temp > 0 and not '{print_temperature}' in alterationContents:
779                         if extruderCount > 0:
780                                 for n in xrange(1, extruderCount):
781                                         t = temp
782                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
783                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
784                                         prefix += 'M104 T%d S%f\n' % (n, t)
785                                 for n in xrange(0, extruderCount):
786                                         t = temp
787                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
788                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
789                                         prefix += 'M109 T%d S%f\n' % (n, t)
790                                 prefix += 'T0\n'
791                         else:
792                                 prefix += 'M109 S%f\n' % (temp)
793                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
794                         prefix += 'M190 S%f\n' % (bedTemp)
795         elif filename == 'end.gcode':
796                 if extruderCount > 1:
797                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
798                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
799                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
800         elif filename == 'replace.csv':
801                 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.
802                 prefix = 'M101\nM103\n'
803         elif filename == 'support_start.gcode' or filename == 'support_end.gcode':
804                 #Add support start/end code 
805                 if getProfileSetting('support_dual_extrusion') == 'True' and int(getPreference('extruder_amount')) > 1:
806                         if filename == 'support_start.gcode':
807                                 setTempOverride('extruder', '1')
808                         else:
809                                 setTempOverride('extruder', '0')
810                         alterationContents = getAlterationFileContents('switchExtruder.gcode')
811                         clearTempOverride('extruder')
812                 else:
813                         alterationContents = ''
814         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
815
816 ###### PLUGIN #####
817
818 def getPluginConfig():
819         try:
820                 return pickle.loads(str(getProfileSetting('plugin_config')))
821         except:
822                 return []
823
824 def setPluginConfig(config):
825         putProfileSetting('plugin_config', pickle.dumps(config))
826
827 def getPluginBasePaths():
828         ret = []
829         if platform.system() != "Windows":
830                 ret.append(os.path.expanduser('~/.cura/plugins/'))
831         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
832                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
833         else:
834                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
835         return ret
836
837 def getPluginList():
838         ret = []
839         for basePath in getPluginBasePaths():
840                 for filename in glob.glob(os.path.join(basePath, '*.py')):
841                         filename = os.path.basename(filename)
842                         if filename.startswith('_'):
843                                 continue
844                         with open(os.path.join(basePath, filename), "r") as f:
845                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
846                                 for line in f:
847                                         line = line.strip()
848                                         if not line.startswith('#'):
849                                                 break
850                                         line = line[1:].split(':', 1)
851                                         if len(line) != 2:
852                                                 continue
853                                         if line[0].upper() == 'NAME':
854                                                 item['name'] = line[1].strip()
855                                         elif line[0].upper() == 'INFO':
856                                                 item['info'] = line[1].strip()
857                                         elif line[0].upper() == 'TYPE':
858                                                 item['type'] = line[1].strip()
859                                         elif line[0].upper() == 'DEPEND':
860                                                 pass
861                                         elif line[0].upper() == 'PARAM':
862                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
863                                                 if m is not None:
864                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
865                                         else:
866                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
867                                 if item['name'] is not None and item['type'] == 'postprocess':
868                                         ret.append(item)
869         return ret
870
871 def runPostProcessingPlugins(gcodefilename):
872         pluginConfigList = getPluginConfig()
873         pluginList = getPluginList()
874
875         for pluginConfig in pluginConfigList:
876                 plugin = None
877                 for pluginTest in pluginList:
878                         if pluginTest['filename'] == pluginConfig['filename']:
879                                 plugin = pluginTest
880                 if plugin is None:
881                         continue
882                 
883                 pythonFile = None
884                 for basePath in getPluginBasePaths():
885                         testFilename = os.path.join(basePath, pluginConfig['filename'])
886                         if os.path.isfile(testFilename):
887                                 pythonFile = testFilename
888                 if pythonFile is None:
889                         continue
890                 
891                 locals = {'filename': gcodefilename}
892                 for param in plugin['params']:
893                         value = param['default']
894                         if param['name'] in pluginConfig['params']:
895                                 value = pluginConfig['params'][param['name']]
896                         
897                         if param['type'] == 'float':
898                                 try:
899                                         value = float(value)
900                                 except:
901                                         value = float(param['default'])
902                         
903                         locals[param['name']] = value
904                 try:
905                         execfile(pythonFile, locals)
906                 except:
907                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
908                         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])
909         return None