chiark / gitweb /
Add minimal skirt length to ensure extruder primed.
[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',  'Both', ['Both', 'First extruder', 'Second extruder'], 'basic', 'Support').setLabel('Support dual extrusion', 'Which extruder to use for support material, for break-away support you can use both extruders.\nBut if one of the materials is more expensive then the other you could select an extruder to use for support material. This causes more extruder switches.\nYou can also use the 2nd extruder for soluble support materials.')
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('skirt_minimal_length',    150.0, float, 'expert', 'Skirt').setRange(0).setLabel('Minimal length (mm)', 'The minimal length of the skirt, if this minimal length is not reached it will add more skirt lines to reach this minimal lenght.\nNote: If the line count is set to 0 this is ignored.')
153 #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.')
154 #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.')
155 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.')
156 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.')
157 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%.')
158 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.')
159 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.')
160 #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.')
161 #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')
162 #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\'')
163 #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.')
164 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.')
165 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.')
166 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.')
167 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.')
168 #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.')
169 #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.')
170 #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.')
171 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.')
172 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.')
173 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.')
174 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.')
175 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.')
176 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.')
177 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.')
178 #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).')
179 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.')
180 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.')
181 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.')
182 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.')
183
184 setting('plugin_config', '', str, 'hidden', 'hidden')
185 setting('object_center_x', -1, float, 'hidden', 'hidden')
186 setting('object_center_y', -1, float, 'hidden', 'hidden')
187
188 setting('start.gcode', """;Sliced at: {day} {date} {time}
189 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
190 ;Print time: {print_time}
191 ;Filament used: {filament_amount}m {filament_weight}g
192 ;Filament cost: {filament_cost}
193 G21        ;metric values
194 G90        ;absolute positioning
195 M107       ;start with the fan off
196
197 G28 X0 Y0  ;move X/Y to min endstops
198 G28 Z0     ;move Z to min endstops
199
200 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
201
202 G92 E0                  ;zero the extruded length
203 G1 F200 E3              ;extrude 3mm of feed stock
204 G92 E0                  ;zero the extruded length again
205 G1 F{travel_speed}
206 M117 Printing...
207 """, str, 'alteration', 'alteration')
208 #######################################################################################
209 setting('end.gcode', """;End GCode
210 M104 S0                     ;extruder heater off
211 M140 S0                     ;heated bed heater off (if you have it)
212
213 G91                                    ;relative positioning
214 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
215 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
216 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
217
218 M84                         ;steppers off
219 G90                         ;absolute positioning
220 """, str, 'alteration', 'alteration')
221 #######################################################################################
222 setting('start2.gcode', """;Sliced at: {day} {date} {time}
223 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
224 ;Print time: {print_time}
225 ;Filament used: {filament_amount}m {filament_weight}g
226 ;Filament cost: {filament_cost}
227 G21        ;metric values
228 G90        ;absolute positioning
229 M107       ;start with the fan off
230
231 G28 X0 Y0  ;move X/Y to min endstops
232 G28 Z0     ;move Z to min endstops
233
234 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
235
236 T1
237 G92 E0                  ;zero the extruded length
238 G1 F200 E10             ;extrude 10mm of feed stock
239 G92 E0                  ;zero the extruded length again
240 G1 F200 E-{retraction_dual_amount}
241
242 T0
243 G92 E0                  ;zero the extruded length
244 G1 F200 E10              ;extrude 10mm of feed stock
245 G92 E0                  ;zero the extruded length again
246 G1 F{travel_speed}
247 M117 Printing...
248 """, str, 'alteration', 'alteration')
249 #######################################################################################
250 setting('end2.gcode', """;End GCode
251 M104 T0 S0                     ;extruder heater off
252 M104 T1 S0                     ;extruder heater off
253 M140 S0                     ;heated bed heater off (if you have it)
254
255 G91                                    ;relative positioning
256 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
257 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
258 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
259
260 M84                         ;steppers off
261 G90                         ;absolute positioning
262 """, str, 'alteration', 'alteration')
263 #######################################################################################
264 setting('support_start.gcode', '', str, 'alteration', 'alteration')
265 setting('support_end.gcode', '', str, 'alteration', 'alteration')
266 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
267 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
268 setting('replace.csv', '', str, 'alteration', 'alteration')
269 #######################################################################################
270 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.
271 G92 E0
272
273 G91                                    ;relative positioning
274 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
275 G1 Z+0.5 E-5 F{travel_speed}           ;move Z up a bit and retract filament even more
276 G90                                    ;absolute positioning
277
278 G1 Z{clear_z} F{max_z_speed}
279 G92 E0
280 G1 X{object_center_x} Y{object_center_y} F{travel_speed}
281 G1 F200 E6
282 G92 E0
283 """, str, 'alteration', 'alteration')
284 #######################################################################################
285 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
286 G92 E0
287 G1 E-36 F5000
288 G92 E0
289 T{extruder}
290 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
291 G1 E36 F5000
292 G92 E0
293 """, str, 'alteration', 'alteration')
294
295 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
296 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
297 setting('machine_width', '205', float, 'preference', 'hidden').setLabel('Maximum width (mm)', 'Size of the machine in mm')
298 setting('machine_depth', '205', float, 'preference', 'hidden').setLabel('Maximum depth (mm)', 'Size of the machine in mm')
299 setting('machine_height', '200', float, 'preference', 'hidden').setLabel('Maximum height (mm)', 'Size of the machine in mm')
300 setting('machine_type', 'unknown', str, 'preference', 'hidden')
301 setting('machine_center_is_zero', 'False', bool, 'preference', 'hidden')
302 setting('ultimaker_extruder_upgrade', 'False', bool, 'preference', 'hidden')
303 setting('has_heated_bed', 'False', bool, 'preference', 'hidden').setLabel('Heated bed', 'If you have an heated bed, this enabled heated bed settings (requires restart)')
304 setting('machine_type', 'unknown', str, 'preference', 'hidden')
305 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode'], 'preference', 'hidden').setLabel('GCode Flavor', 'Flavor of generated GCode.\nRepRap...')
306 setting('extruder_amount', '1', ['1','2','3','4'], 'preference', 'hidden').setLabel('Extruder count', 'Amount of extruders in your machine.')
307 setting('extruder_offset_x1', '-21.6', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
308 setting('extruder_offset_y1', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
309 setting('extruder_offset_x2', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
310 setting('extruder_offset_y2', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
311 setting('extruder_offset_x3', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
312 setting('extruder_offset_y3', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
313 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.')
314 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.')
315 setting('serial_port', 'AUTO', str, 'preference', 'hidden').setLabel('Serial port', 'Serial port to use for communication with the printer')
316 setting('serial_port_auto', '', str, 'preference', 'hidden')
317 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')
318 setting('serial_baud_auto', '', int, 'preference', 'hidden')
319 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.')
320 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.')
321 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.')
322 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.')
323 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
324 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
325
326 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.')
327 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.')
328 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.')
329 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.')
330 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.')
331
332 setting('model_colour', '#7AB645', str, 'preference', 'hidden').setLabel('Model colour')
333 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
334 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
335 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
336
337 setting('window_maximized', 'True', bool, 'preference', 'hidden')
338 setting('window_pos_x', '-1', float, 'preference', 'hidden')
339 setting('window_pos_y', '-1', float, 'preference', 'hidden')
340 setting('window_width', '-1', float, 'preference', 'hidden')
341 setting('window_height', '-1', float, 'preference', 'hidden')
342 setting('window_normal_sash', '320', float, 'preference', 'hidden')
343
344 validators.warningAbove(settingsDictionary['filament_flow'], 150, "More flow then 150% is rare and usually not recommended.")
345 validators.warningBelow(settingsDictionary['filament_flow'], 50, "More flow then 50% is rare and usually not recommended.")
346 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.")
347 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
348 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
349 validators.printSpeedValidator(settingsDictionary['print_speed'])
350 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
351 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
352 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
353 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
354 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
355 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
356 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
357 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
358 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
359 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.")
360
361 #Conditions for multiple extruders
362 settingsDictionary['print_temperature2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
363 settingsDictionary['print_temperature3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
364 settingsDictionary['print_temperature4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
365 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
366 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
367 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
368 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
369 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
370 #Heated bed
371 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('has_heated_bed') == 'True')
372
373 #UltiGCode uses less settings
374 settingsDictionary['print_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
375 settingsDictionary['print_temperature2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
376 settingsDictionary['print_temperature3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
377 settingsDictionary['print_temperature4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
378 settingsDictionary['filament_diameter'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
379 settingsDictionary['filament_diameter2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
380 settingsDictionary['filament_diameter3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
381 settingsDictionary['filament_diameter4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
382 settingsDictionary['filament_flow'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
383 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
384 settingsDictionary['retraction_speed'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
385 settingsDictionary['retraction_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
386 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
387
388 #########################################################
389 ## Profile and preferences functions
390 #########################################################
391
392 def getSubCategoriesFor(category):
393         done = {}
394         ret = []
395         for s in settingsList:
396                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
397                         done[s.getSubCategory()] = True
398                         ret.append(s.getSubCategory())
399         return ret
400
401 def getSettingsForCategory(category, subCategory = None):
402         ret = []
403         for s in settingsList:
404                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
405                         ret.append(s)
406         return ret
407
408 ## Profile functions
409 def getBasePath():
410         if platform.system() == "Windows":
411                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
412                 #If we have a frozen python install, we need to step out of the library.zip
413                 if hasattr(sys, 'frozen'):
414                         basePath = os.path.normpath(os.path.join(basePath, ".."))
415         else:
416                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
417         if not os.path.isdir(basePath):
418                 os.makedirs(basePath)
419         return basePath
420
421 def getAlternativeBasePaths():
422         paths = []
423         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
424         for subPath in os.listdir(basePath):
425                 path = os.path.join(basePath, subPath)
426                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
427                         paths.append(path)
428                 path = os.path.join(basePath, subPath, 'Cura')
429                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
430                         paths.append(path)
431         return paths
432
433 def getDefaultProfilePath():
434         return os.path.join(getBasePath(), 'current_profile.ini')
435
436 def loadProfile(filename):
437         #Read a configuration file as global config
438         profileParser = ConfigParser.ConfigParser()
439         try:
440                 profileParser.read(filename)
441         except ConfigParser.ParsingError:
442                 return
443         global settingsList
444         for set in settingsList:
445                 if set.isPreference():
446                         continue
447                 section = 'profile'
448                 if set.isAlteration():
449                         section = 'alterations'
450                 if profileParser.has_option(section, set.getName()):
451                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
452
453 def saveProfile(filename):
454         #Save the current profile to an ini file
455         profileParser = ConfigParser.ConfigParser()
456         profileParser.add_section('profile')
457         profileParser.add_section('alterations')
458         global settingsList
459         for set in settingsList:
460                 if set.isPreference():
461                         continue
462                 if set.isAlteration():
463                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
464                 else:
465                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
466
467         profileParser.write(open(filename, 'w'))
468
469 def resetProfile():
470         #Read a configuration file as global config
471         global settingsList
472         for set in settingsList:
473                 if set.isPreference():
474                         continue
475                 set.setValue(set.getDefault())
476
477         if getPreference('machine_type') == 'ultimaker':
478                 putProfileSetting('nozzle_size', '0.4')
479                 if getPreference('ultimaker_extruder_upgrade') == 'True':
480                         putProfileSetting('retraction_enable', 'True')
481         else:
482                 putProfileSetting('nozzle_size', '0.5')
483
484 def loadProfileFromString(options):
485         options = base64.b64decode(options)
486         options = zlib.decompress(options)
487         (profileOpts, alt) = options.split('\f', 1)
488         global settingsDictionary
489         for option in profileOpts.split('\b'):
490                 if len(option) > 0:
491                         (key, value) = option.split('=', 1)
492                         if key in settingsDictionary:
493                                 if settingsDictionary[key].isProfile():
494                                         settingsDictionary[key].setValue(value)
495         for option in alt.split('\b'):
496                 if len(option) > 0:
497                         (key, value) = option.split('=', 1)
498                         if key in settingsDictionary:
499                                 if settingsDictionary[key].isAlteration():
500                                         settingsDictionary[key].setValue(value)
501
502 def getProfileString():
503         p = []
504         alt = []
505         global settingsList
506         for set in settingsList:
507                 if set.isProfile():
508                         if set.getName() in tempOverride:
509                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
510                         else:
511                                 p.append(set.getName() + "=" + set.getValue())
512                 if set.isAlteration():
513                         if set.getName() in tempOverride:
514                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
515                         else:
516                                 alt.append(set.getName() + "=" + set.getValue())
517         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
518         ret = base64.b64encode(zlib.compress(ret, 9))
519         return ret
520
521 def getGlobalPreferencesString():
522         p = []
523         global settingsList
524         for set in settingsList:
525                 if set.isPreference():
526                         p.append(set.getName() + "=" + set.getValue())
527         ret = '\b'.join(p)
528         ret = base64.b64encode(zlib.compress(ret, 9))
529         return ret
530
531
532 def getProfileSetting(name):
533         if name in tempOverride:
534                 return tempOverride[name]
535         global settingsDictionary
536         if name in settingsDictionary and settingsDictionary[name].isProfile():
537                 return settingsDictionary[name].getValue()
538         print 'Error: "%s" not found in profile settings' % (name)
539         return ''
540
541 def getProfileSettingFloat(name):
542         try:
543                 setting = getProfileSetting(name).replace(',', '.')
544                 return float(eval(setting, {}, {}))
545         except:
546                 return 0.0
547
548 def putProfileSetting(name, value):
549         #Check if we have a configuration file loaded, else load the default.
550         global settingsDictionary
551         if name in settingsDictionary and settingsDictionary[name].isProfile():
552                 settingsDictionary[name].setValue(value)
553
554 def isProfileSetting(name):
555         global settingsDictionary
556         if name in settingsDictionary and settingsDictionary[name].isProfile():
557                 return True
558         return False
559
560 ## Preferences functions
561 def getPreferencePath():
562         return os.path.join(getBasePath(), 'preferences.ini')
563
564 def getPreferenceFloat(name):
565         try:
566                 setting = getPreference(name).replace(',', '.')
567                 return float(eval(setting, {}, {}))
568         except:
569                 return 0.0
570
571 def getPreferenceColour(name):
572         colorString = getPreference(name)
573         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
574
575 def loadPreferences(filename):
576         #Read a configuration file as global config
577         profileParser = ConfigParser.ConfigParser()
578         try:
579                 profileParser.read(filename)
580         except ConfigParser.ParsingError:
581                 return
582         global settingsList
583         for set in settingsList:
584                 if set.isPreference():
585                         if profileParser.has_option('preference', set.getName()):
586                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
587
588 def savePreferences(filename):
589         #Save the current profile to an ini file
590         parser = ConfigParser.ConfigParser()
591         parser.add_section('preference')
592         global settingsList
593         for set in settingsList:
594                 if set.isPreference():
595                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
596         parser.write(open(filename, 'w'))
597
598 def getPreference(name):
599         if name in tempOverride:
600                 return tempOverride[name]
601         global settingsDictionary
602         if name in settingsDictionary and settingsDictionary[name].isPreference():
603                 return settingsDictionary[name].getValue()
604         print 'Error: "%s" not found in profile settings' % (name)
605         return ''
606
607 def putPreference(name, value):
608         #Check if we have a configuration file loaded, else load the default.
609         global settingsDictionary
610         if name in settingsDictionary and settingsDictionary[name].isPreference():
611                 settingsDictionary[name].setValue(value)
612         savePreferences(getPreferencePath())
613
614 def isPreference(name):
615         global settingsDictionary
616         if name in settingsDictionary and settingsDictionary[name].isPreference():
617                 return True
618         return False
619
620 ## Temp overrides for multi-extruder slicing and the project planner.
621 tempOverride = {}
622 def setTempOverride(name, value):
623         tempOverride[name] = unicode(value).encode("utf-8")
624 def clearTempOverride(name):
625         del tempOverride[name]
626 def resetTempOverride():
627         tempOverride.clear()
628
629 #########################################################
630 ## Utility functions to calculate common profile values
631 #########################################################
632 def calculateEdgeWidth():
633         wallThickness = getProfileSettingFloat('wall_thickness')
634         nozzleSize = getProfileSettingFloat('nozzle_size')
635
636         if wallThickness < 0.01:
637                 return nozzleSize
638         if wallThickness < nozzleSize:
639                 return wallThickness
640
641         lineCount = int(wallThickness / (nozzleSize + 0.0001))
642         lineWidth = wallThickness / lineCount
643         lineWidthAlt = wallThickness / (lineCount + 1)
644         if lineWidth > nozzleSize * 1.5:
645                 return lineWidthAlt
646         return lineWidth
647
648 def calculateLineCount():
649         wallThickness = getProfileSettingFloat('wall_thickness')
650         nozzleSize = getProfileSettingFloat('nozzle_size')
651
652         if wallThickness < 0.01:
653                 return 0
654         if wallThickness < nozzleSize:
655                 return 1
656
657         lineCount = int(wallThickness / (nozzleSize + 0.0001))
658         lineWidth = wallThickness / lineCount
659         lineWidthAlt = wallThickness / (lineCount + 1)
660         if lineWidth > nozzleSize * 1.5:
661                 return lineCount + 1
662         return lineCount
663
664 def calculateSolidLayerCount():
665         layerHeight = getProfileSettingFloat('layer_height')
666         solidThickness = getProfileSettingFloat('solid_layer_thickness')
667         if layerHeight == 0.0:
668                 return 1
669         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
670
671 def calculateObjectSizeOffsets():
672         size = 0.0
673
674         if getProfileSetting('platform_adhesion') == 'Brim':
675                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
676         elif getProfileSetting('platform_adhesion') == 'Raft':
677                 pass
678         else:
679                 if getProfileSettingFloat('skirt_line_count') > 0:
680                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
681
682         #if getProfileSetting('enable_raft') != 'False':
683         #       size += profile.getProfileSettingFloat('raft_margin') * 2
684         #if getProfileSetting('support') != 'None':
685         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
686         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
687         return [size, size]
688
689 def getMachineCenterCoords():
690         if getPreference('machine_center_is_zero') == 'True':
691                 return [0, 0]
692         return [getPreferenceFloat('machine_width') / 2, getPreferenceFloat('machine_depth') / 2]
693
694 #########################################################
695 ## Alteration file functions
696 #########################################################
697 def replaceTagMatch(m):
698         pre = m.group(1)
699         tag = m.group(2)
700         if tag == 'time':
701                 return pre + time.strftime('%H:%M:%S').encode('ascii', 'replace')
702         if tag == 'date':
703                 return pre + time.strftime('%d %b %Y').encode('ascii', 'replace')
704         if tag == 'day':
705                 return pre + time.strftime('%a').encode('ascii', 'replace')
706         if tag == 'print_time':
707                 return pre + '#P_TIME#'
708         if tag == 'filament_amount':
709                 return pre + '#F_AMNT#'
710         if tag == 'filament_weight':
711                 return pre + '#F_WGHT#'
712         if tag == 'filament_cost':
713                 return pre + '#F_COST#'
714         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
715                 f = getProfileSettingFloat(tag) * 60
716         elif isProfileSetting(tag):
717                 f = getProfileSettingFloat(tag)
718         elif isPreference(tag):
719                 f = getProfileSettingFloat(tag)
720         else:
721                 return '%s?%s?' % (pre, tag)
722         if (f % 1) == 0:
723                 return pre + str(int(f))
724         return pre + str(f)
725
726 def replaceGCodeTags(filename, gcodeInt):
727         f = open(filename, 'r+')
728         data = f.read(2048)
729         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
730         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
731         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
732         cost = gcodeInt.calculateCost()
733         if cost is None:
734                 cost = 'Unknown'
735         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
736         f.seek(0)
737         f.write(data)
738         f.close()
739
740 ### Get aleration raw contents. (Used internally in Cura)
741 def getAlterationFile(filename):
742         if filename in tempOverride:
743                 return tempOverride[filename]
744         global settingsDictionary
745         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
746                 return settingsDictionary[filename].getValue()
747         print 'Error: "%s" not found in profile settings' % (filename)
748         return ''
749
750 def setAlterationFile(name, value):
751         #Check if we have a configuration file loaded, else load the default.
752         global settingsDictionary
753         if name in settingsDictionary and settingsDictionary[name].isAlteration():
754                 settingsDictionary[name].setValue(value)
755         saveProfile(getDefaultProfilePath())
756
757 ### Get the alteration file for output. (Used by Skeinforge)
758 def getAlterationFileContents(filename, extruderCount = 1):
759         prefix = ''
760         postfix = ''
761         alterationContents = getAlterationFile(filename)
762         if getPreference('gcode_flavor') == 'UltiGCode':
763                 return ''
764         if filename == 'start.gcode':
765                 if extruderCount > 1:
766                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
767                 #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.
768                 #We also set our steps per E here, if configured.
769                 eSteps = getPreferenceFloat('steps_per_e')
770                 if eSteps > 0:
771                         prefix += 'M92 E%f\n' % (eSteps)
772                 temp = getProfileSettingFloat('print_temperature')
773                 bedTemp = 0
774                 if getPreference('has_heated_bed') == 'True':
775                         bedTemp = getProfileSettingFloat('print_bed_temperature')
776                 
777                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
778                         prefix += 'M140 S%f\n' % (bedTemp)
779                 if temp > 0 and not '{print_temperature}' in alterationContents:
780                         if extruderCount > 0:
781                                 for n in xrange(1, extruderCount):
782                                         t = temp
783                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
784                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
785                                         prefix += 'M104 T%d S%f\n' % (n, t)
786                                 for n in xrange(0, extruderCount):
787                                         t = temp
788                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
789                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
790                                         prefix += 'M109 T%d S%f\n' % (n, t)
791                                 prefix += 'T0\n'
792                         else:
793                                 prefix += 'M109 S%f\n' % (temp)
794                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
795                         prefix += 'M190 S%f\n' % (bedTemp)
796         elif filename == 'end.gcode':
797                 if extruderCount > 1:
798                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
799                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
800                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
801         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
802
803 ###### PLUGIN #####
804
805 def getPluginConfig():
806         try:
807                 return pickle.loads(str(getProfileSetting('plugin_config')))
808         except:
809                 return []
810
811 def setPluginConfig(config):
812         putProfileSetting('plugin_config', pickle.dumps(config))
813
814 def getPluginBasePaths():
815         ret = []
816         if platform.system() != "Windows":
817                 ret.append(os.path.expanduser('~/.cura/plugins/'))
818         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
819                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
820         else:
821                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
822         return ret
823
824 def getPluginList():
825         ret = []
826         for basePath in getPluginBasePaths():
827                 for filename in glob.glob(os.path.join(basePath, '*.py')):
828                         filename = os.path.basename(filename)
829                         if filename.startswith('_'):
830                                 continue
831                         with open(os.path.join(basePath, filename), "r") as f:
832                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
833                                 for line in f:
834                                         line = line.strip()
835                                         if not line.startswith('#'):
836                                                 break
837                                         line = line[1:].split(':', 1)
838                                         if len(line) != 2:
839                                                 continue
840                                         if line[0].upper() == 'NAME':
841                                                 item['name'] = line[1].strip()
842                                         elif line[0].upper() == 'INFO':
843                                                 item['info'] = line[1].strip()
844                                         elif line[0].upper() == 'TYPE':
845                                                 item['type'] = line[1].strip()
846                                         elif line[0].upper() == 'DEPEND':
847                                                 pass
848                                         elif line[0].upper() == 'PARAM':
849                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
850                                                 if m is not None:
851                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
852                                         else:
853                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
854                                 if item['name'] is not None and item['type'] == 'postprocess':
855                                         ret.append(item)
856         return ret
857
858 def runPostProcessingPlugins(gcodefilename):
859         pluginConfigList = getPluginConfig()
860         pluginList = getPluginList()
861
862         for pluginConfig in pluginConfigList:
863                 plugin = None
864                 for pluginTest in pluginList:
865                         if pluginTest['filename'] == pluginConfig['filename']:
866                                 plugin = pluginTest
867                 if plugin is None:
868                         continue
869                 
870                 pythonFile = None
871                 for basePath in getPluginBasePaths():
872                         testFilename = os.path.join(basePath, pluginConfig['filename'])
873                         if os.path.isfile(testFilename):
874                                 pythonFile = testFilename
875                 if pythonFile is None:
876                         continue
877                 
878                 locals = {'filename': gcodefilename}
879                 for param in plugin['params']:
880                         value = param['default']
881                         if param['name'] in pluginConfig['params']:
882                                 value = pluginConfig['params'][param['name']]
883                         
884                         if param['type'] == 'float':
885                                 try:
886                                         value = float(value)
887                                 except:
888                                         value = float(param['default'])
889                         
890                         locals[param['name']] = value
891                 try:
892                         execfile(pythonFile, locals)
893                 except:
894                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
895                         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])
896         return None