chiark / gitweb /
Merge branch 'master' into SteamEngine
[cura.git] / Cura / util / profile.py
1 from __future__ import absolute_import
2 from __future__ import division
3
4 import os, traceback, math, re, zlib, base64, time, sys, platform, glob, string, stat, types
5 import cPickle as pickle
6 if sys.version_info[0] < 3:
7         import ConfigParser
8 else:
9         import configparser as ConfigParser
10
11 from Cura.util import resources
12 from Cura.util import version
13 from Cura.util import validators
14
15 settingsDictionary = {}
16 settingsList = []
17 class setting(object):
18         def __init__(self, name, default, type, category, subcategory):
19                 self._name = name
20                 self._label = name
21                 self._tooltip = ''
22                 self._default = unicode(default)
23                 self._value = self._default
24                 self._type = type
25                 self._category = category
26                 self._subcategory = subcategory
27                 self._validators = []
28                 self._conditions = []
29
30                 if type is types.FloatType:
31                         validators.validFloat(self)
32                 elif type is types.IntType:
33                         validators.validInt(self)
34
35                 global settingsDictionary
36                 settingsDictionary[name] = self
37                 global settingsList
38                 settingsList.append(self)
39
40         def setLabel(self, label, tooltip = ''):
41                 self._label = label
42                 self._tooltip = tooltip
43                 return self
44
45         def setRange(self, minValue = None, maxValue = None):
46                 if len(self._validators) < 1:
47                         return
48                 self._validators[0].minValue = minValue
49                 self._validators[0].maxValue = maxValue
50                 return self
51
52         def getLabel(self):
53                 return self._label
54
55         def getTooltip(self):
56                 return self._tooltip
57
58         def getCategory(self):
59                 return self._category
60
61         def getSubCategory(self):
62                 return self._subcategory
63
64         def isPreference(self):
65                 return self._category == 'preference'
66
67         def isAlteration(self):
68                 return self._category == 'alteration'
69
70         def isProfile(self):
71                 return not self.isAlteration() and not self.isPreference()
72
73         def getName(self):
74                 return self._name
75
76         def getType(self):
77                 return self._type
78
79         def getValue(self):
80                 return self._value
81
82         def getDefault(self):
83                 return self._default
84
85         def setValue(self, value):
86                 self._value = unicode(value)
87
88         def validate(self):
89                 result = validators.SUCCESS
90                 msgs = []
91                 for validator in self._validators:
92                         res, err = validator.validate()
93                         if res == validators.ERROR:
94                                 result = res
95                         elif res == validators.WARNING and result != validators.ERROR:
96                                 result = res
97                         if res != validators.SUCCESS:
98                                 msgs.append(err)
99                 return result, '\n'.join(msgs)
100
101         def addCondition(self, conditionFunction):
102                 self._conditions.append(conditionFunction)
103
104         def checkConditions(self):
105                 for condition in self._conditions:
106                         if not condition():
107                                 return False
108                 return True
109
110 #########################################################
111 ## Settings
112 #########################################################
113 setting('layer_height',              0.2, float, 'basic',    'Quality').setRange(0.0001).setLabel('Layer height (mm)', 'Layer height in millimeters.\n0.2 is a good value for quick prints.\n0.1 gives high quality prints.\nDepending on your printer you can go as low as 0.02mm')
114 setting('wall_thickness',            0.8, float, 'basic',    'Quality').setRange(0.0001).setLabel('Wall thickness (mm)', 'Thickness of the walls.\nThis is used in combination with the nozzle size to define the number\nof perimeter lines and the thickness of those perimeter lines.')
115 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.')
116 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.')
117 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.')
118 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.')
119 setting('skirt_line_count',            1, int,   'advanced', '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.')
120 setting('skirt_gap',                 3.0, float, 'advanced', '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.')
121 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.')
122 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.')
123 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.')
124 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.')
125 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.')
126 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.')
127 setting('support',                'None', ['None', 'Touching buildplate', 'Everywhere'], 'basic', 'Support').setLabel('Support type', 'Type of support structure build.\n"Exterior only" 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.')
128 setting('enable_raft',             False, bool,  'basic',   'Support').setLabel('Enable raft', 'A raft is a few layers of lines below the bottom of the object. It prevents warping. Full raft settings can be found in the expert settings.\nFor PLA this is usually not required. But if you print with ABS it is almost required.')
129 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.')
130 setting('filament_diameter',        2.89, 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.')
131 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.')
132 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.')
133 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.')
134 setting('filament_density',         1.00, float, 'basic',    'Filament').setRange(0.5,1.5).setLabel('Packing Density', 'Packing density of your filament. This should be 1.00 for PLA and 0.85 for ABS')
135 #setting('retraction_min_travel',     5.0, float, 'advanced', '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')
136 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.')
137 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 2.0mm seems to generate good results.')
138 #setting('retraction_extra',          0.0, float, 'advanced', 'Retraction').setRange(0).setLabel('Extra length on start (mm)', 'Extra extrusion amount when restarting after a retraction, to better "Prime" your extruder after retraction.')
139 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.')
140 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.')
141 #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.')
142 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.')
143 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.')
144 #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.')
145 #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 essensial during faster prints.')
146 #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.')
147 #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.')
148 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.')
149 #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.')
150 #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 then 200%.')
151 #setting('cool_min_feedrate',          10, float, 'expert',   'Cool').setRange(0).setLabel('Minimum feedrate (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 then this minimal feedrate.')
152 #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.')
153 #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')
154 #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\'')
155 #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.')
156 #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.')
157 #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.')
158 #setting('support_rate', 50, 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.')
159 #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.')
160 #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.')
161 #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.')
162 #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.')
163 #setting('raft_base_material_amount', 100, int, 'expert', 'Raft').setRange(0,100).setLabel('Base material amount (%)', 'The base layer is the first layer put down as a raft. This layer has thick strong lines and is put firmly on the bed to prevent warping. This setting adjust the amount of material used for the base layer.')
164 #setting('raft_interface_material_amount', 100, int, 'expert', 'Raft').setRange(0,100).setLabel('Interface material amount (%)', 'The interface layer is a weak thin layer between the base layer and the printed object. It is designed to has little material to make it easy to break the base off the printed object. This setting adjusts the amount of material used for the interface layer.')
165 #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).')
166
167 setting('plugin_config', '', str, 'hidden', 'hidden')
168 setting('object_center_x', -1, float, 'hidden', 'hidden')
169 setting('object_center_y', -1, float, 'hidden', 'hidden')
170
171 setting('start.gcode', """;Sliced {filename} at: {day} {date} {time}
172 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
173 ;Print time: {print_time}
174 ;Filament used: {filament_amount}m {filament_weight}g
175 ;Filament cost: {filament_cost}
176 G21        ;metric values
177 G90        ;absolute positioning
178 M107       ;start with the fan off
179
180 G28 X0 Y0  ;move X/Y to min endstops
181 G28 Z0     ;move Z to min endstops
182
183 G1 Z15.0 F{max_z_speed} ;move the platform down 15mm
184
185 G92 E0                  ;zero the extruded length
186 G1 F200 E3              ;extrude 3mm of feed stock
187 G92 E0                  ;zero the extruded length again
188 G1 F{travel_speed}
189 M117 Printing...
190 """, str, 'alteration', 'alteration')
191 #######################################################################################
192 setting('end.gcode', """;End GCode
193 M104 S0                     ;extruder heater off
194 M140 S0                     ;heated bed heater off (if you have it)
195
196 G91                                    ;relative positioning
197 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
198 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
199 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
200
201 M84                         ;steppers off
202 G90                         ;absolute positioning
203 """, str, 'alteration', 'alteration')
204 #######################################################################################
205 setting('support_start.gcode', '', str, 'alteration', 'alteration')
206 setting('support_end.gcode', '', str, 'alteration', 'alteration')
207 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
208 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
209 setting('replace.csv', '', str, 'alteration', 'alteration')
210 #######################################################################################
211 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.
212 G92 E0
213
214 G91                                    ;relative positioning
215 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
216 G1 Z+0.5 E-5 F{travel_speed}           ;move Z up a bit and retract filament even more
217 G90                                    ;absolute positioning
218
219 G1 Z{clear_z} F{max_z_speed}
220 G92 E0
221 G1 X{object_center_x} Y{object_center_y} F{travel_speed}
222 G1 F200 E6
223 G92 E0
224 """, str, 'alteration', 'alteration')
225 #######################################################################################
226 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
227 G92 E0
228 G1 E-36 F5000
229 G92 E0
230 T{extruder}
231 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
232 G1 E36 F5000
233 G92 E0
234 """, str, 'alteration', 'alteration')
235
236 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
237 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
238 setting('machine_width', '205', float, 'preference', 'hidden').setLabel('Maximum width (mm)', 'Size of the machine in mm')
239 setting('machine_depth', '205', float, 'preference', 'hidden').setLabel('Maximum depth (mm)', 'Size of the machine in mm')
240 setting('machine_height', '200', float, 'preference', 'hidden').setLabel('Maximum height (mm)', 'Size of the machine in mm')
241 setting('machine_type', 'unknown', str, 'preference', 'hidden')
242 setting('machine_center_is_zero', 'False', bool, 'preference', 'hidden')
243 setting('ultimaker_extruder_upgrade', 'False', bool, 'preference', 'hidden')
244 setting('has_heated_bed', 'False', bool, 'preference', 'hidden').setLabel('Heated bed', 'If you have an heated bed, this enabled heated bed settings (requires restart)')
245 setting('reprap_name', 'RepRap', str, 'preference', 'hidden')
246 setting('extruder_amount', '1', ['1','2','3','4'], 'preference', 'hidden').setLabel('Extruder count', 'Amount of extruders in your machine.')
247 setting('extruder_offset_x1', '-21.6', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
248 setting('extruder_offset_y1', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
249 setting('extruder_offset_x2', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
250 setting('extruder_offset_y2', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
251 setting('extruder_offset_x3', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
252 setting('extruder_offset_y3', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
253 setting('filament_physical_density', '1300', float, 'preference', 'hidden').setRange(500.0, 3000.0).setLabel('Density (kg/m3)', 'Weight of the filament per m3. Around 1300 for PLA. And around 1040 for ABS. This value is used to estimate the weight if the filament used for the print.')
254 setting('steps_per_e', '0', float, 'preference', 'hidden').setRange(0).setLabel('E-Steps per 1mm filament', 'Amount of steps per mm filament extrusion')
255 setting('serial_port', 'AUTO', str, 'preference', 'hidden').setLabel('Serial port', 'Serial port to use for communication with the printer')
256 setting('serial_port_auto', '', str, 'preference', 'hidden')
257 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')
258 setting('serial_baud_auto', '', int, 'preference', 'hidden')
259 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.')
260 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.')
261 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.')
262 setting('sdpath', '', str, 'preference', 'hidden').setLabel('SD card drive', 'Location of your SD card, when using the copy to SD feature.')
263 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
264 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
265
266 setting('planner_always_autoplace', 'True', bool, 'preference', 'hidden')
267 setting('extruder_head_size_min_x', '75.0', float, 'preference', 'hidden')
268 setting('extruder_head_size_min_y', '18.0', float, 'preference', 'hidden')
269 setting('extruder_head_size_max_x', '18.0', float, 'preference', 'hidden')
270 setting('extruder_head_size_max_y', '35.0', float, 'preference', 'hidden')
271 setting('extruder_head_size_height', '60.0', float, 'preference', 'hidden')
272
273 setting('model_colour', '#7AB645', str, 'preference', 'hidden').setLabel('Model colour')
274 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
275 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
276 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
277
278 setting('window_maximized', 'True', bool, 'preference', 'hidden')
279 setting('window_pos_x', '-1', float, 'preference', 'hidden')
280 setting('window_pos_y', '-1', float, 'preference', 'hidden')
281 setting('window_width', '-1', float, 'preference', 'hidden')
282 setting('window_height', '-1', float, 'preference', 'hidden')
283 setting('window_normal_sash', '320', float, 'preference', 'hidden')
284
285 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.")
286 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
287 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
288 validators.printSpeedValidator(settingsDictionary['print_speed'])
289 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
290 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
291 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
292 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
293 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
294 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
295 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
296 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
297 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
298 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.")
299
300 #Conditions for multiple extruders
301 settingsDictionary['print_temperature2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
302 settingsDictionary['print_temperature3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
303 settingsDictionary['print_temperature4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
304 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
305 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
306 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
307 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
308 #Heated bed
309 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('has_heated_bed') == 'True')
310
311 #########################################################
312 ## Profile and preferences functions
313 #########################################################
314
315 def getSubCategoriesFor(category):
316         done = {}
317         ret = []
318         for s in settingsList:
319                 if s.getCategory() == category and not s.getSubCategory() in done:
320                         done[s.getSubCategory()] = True
321                         ret.append(s.getSubCategory())
322         return ret
323
324 def getSettingsForCategory(category, subCategory = None):
325         ret = []
326         for s in settingsList:
327                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory):
328                         ret.append(s)
329         return ret
330
331 ## Profile functions
332 def getBasePath():
333         if platform.system() == "Windows":
334                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
335                 #If we have a frozen python install, we need to step out of the library.zip
336                 if hasattr(sys, 'frozen'):
337                         basePath = os.path.normpath(os.path.join(basePath, ".."))
338         else:
339                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
340         if not os.path.isdir(basePath):
341                 os.makedirs(basePath)
342         return basePath
343
344 def getDefaultProfilePath():
345         return os.path.join(getBasePath(), 'current_profile.ini')
346
347 def loadProfile(filename):
348         #Read a configuration file as global config
349         profileParser = ConfigParser.ConfigParser()
350         try:
351                 profileParser.read(filename)
352         except ConfigParser.ParsingError:
353                 return
354         global settingsList
355         for set in settingsList:
356                 if set.isPreference():
357                         continue
358                 section = 'profile'
359                 if set.isAlteration():
360                         section = 'alterations'
361                 if profileParser.has_option(section, set.getName()):
362                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
363
364 def saveProfile(filename):
365         #Save the current profile to an ini file
366         profileParser = ConfigParser.ConfigParser()
367         profileParser.add_section('profile')
368         profileParser.add_section('alterations')
369         global settingsList
370         for set in settingsList:
371                 if set.isPreference():
372                         continue
373                 if set.isAlteration():
374                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
375                 else:
376                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
377
378         profileParser.write(open(filename, 'w'))
379
380 def resetProfile():
381         #Read a configuration file as global config
382         global settingsList
383         for set in settingsList:
384                 if set.isPreference():
385                         continue
386                 set.setValue(set.getDefault())
387
388         if getPreference('machine_type') == 'ultimaker':
389                 putProfileSetting('nozzle_size', '0.4')
390                 if getPreference('ultimaker_extruder_upgrade') == 'True':
391                         putProfileSetting('retraction_enable', 'True')
392         else:
393                 putProfileSetting('nozzle_size', '0.5')
394
395 def loadProfileFromString(options):
396         options = base64.b64decode(options)
397         options = zlib.decompress(options)
398         (profileOpts, alt) = options.split('\f', 1)
399         global settingsDictionary
400         for option in profileOpts.split('\b'):
401                 if len(option) > 0:
402                         (key, value) = option.split('=', 1)
403                         if key in settingsDictionary:
404                                 if settingsDictionary[key].isProfile():
405                                         settingsDictionary[key].setValue(value)
406         for option in alt.split('\b'):
407                 if len(option) > 0:
408                         (key, value) = option.split('=', 1)
409                         if key in settingsDictionary:
410                                 if settingsDictionary[key].isAlteration():
411                                         settingsDictionary[key].setValue(value)
412
413 def getProfileString():
414         p = []
415         alt = []
416         global settingsList
417         for set in settingsList:
418                 if set.isProfile():
419                         if set.getName() in tempOverride:
420                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
421                         else:
422                                 p.append(set.getName() + "=" + set.getValue())
423                 if set.isAlteration():
424                         if set.getName() in tempOverride:
425                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
426                         else:
427                                 alt.append(set.getName() + "=" + set.getValue())
428         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
429         ret = base64.b64encode(zlib.compress(ret, 9))
430         return ret
431
432 def getGlobalPreferencesString():
433         p = []
434         global settingsList
435         for set in settingsList:
436                 if set.isPreference():
437                         p.append(set.getName() + "=" + set.getValue())
438         ret = '\b'.join(p)
439         ret = base64.b64encode(zlib.compress(ret, 9))
440         return ret
441
442
443 def getProfileSetting(name):
444         if name in tempOverride:
445                 return tempOverride[name]
446         global settingsDictionary
447         if name in settingsDictionary and settingsDictionary[name].isProfile():
448                 return settingsDictionary[name].getValue()
449         print 'Error: "%s" not found in profile settings' % (name)
450         return ''
451
452 def getProfileSettingFloat(name):
453         try:
454                 setting = getProfileSetting(name).replace(',', '.')
455                 return float(eval(setting, {}, {}))
456         except:
457                 return 0.0
458
459 def putProfileSetting(name, value):
460         #Check if we have a configuration file loaded, else load the default.
461         global settingsDictionary
462         if name in settingsDictionary and settingsDictionary[name].isProfile():
463                 settingsDictionary[name].setValue(value)
464
465 def isProfileSetting(name):
466         global settingsDictionary
467         if name in settingsDictionary and settingsDictionary[name].isProfile():
468                 return True
469         return False
470
471 ## Preferences functions
472 def getPreferencePath():
473         return os.path.join(getBasePath(), 'preferences.ini')
474
475 def getPreferenceFloat(name):
476         try:
477                 setting = getPreference(name).replace(',', '.')
478                 return float(eval(setting, {}, {}))
479         except:
480                 return 0.0
481
482 def getPreferenceColour(name):
483         colorString = getPreference(name)
484         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
485
486 def loadPreferences(filename):
487         #Read a configuration file as global config
488         profileParser = ConfigParser.ConfigParser()
489         try:
490                 profileParser.read(filename)
491         except ConfigParser.ParsingError:
492                 return
493         global settingsList
494         for set in settingsList:
495                 if set.isPreference():
496                         if profileParser.has_option('preference', set.getName()):
497                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
498
499 def savePreferences(filename):
500         #Save the current profile to an ini file
501         parser = ConfigParser.ConfigParser()
502         parser.add_section('preference')
503         global settingsList
504         for set in settingsList:
505                 if set.isPreference():
506                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
507         parser.write(open(filename, 'w'))
508
509 def getPreference(name):
510         if name in tempOverride:
511                 return tempOverride[name]
512         global settingsDictionary
513         if name in settingsDictionary and settingsDictionary[name].isPreference():
514                 return settingsDictionary[name].getValue()
515         print 'Error: "%s" not found in profile settings' % (name)
516         return ''
517
518 def putPreference(name, value):
519         #Check if we have a configuration file loaded, else load the default.
520         global settingsDictionary
521         if name in settingsDictionary and settingsDictionary[name].isPreference():
522                 settingsDictionary[name].setValue(value)
523         savePreferences(getPreferencePath())
524
525 def isPreference(name):
526         global settingsDictionary
527         if name in settingsDictionary and settingsDictionary[name].isPreference():
528                 return True
529         return False
530
531 ## Temp overrides for multi-extruder slicing and the project planner.
532 tempOverride = {}
533 def setTempOverride(name, value):
534         tempOverride[name] = unicode(value).encode("utf-8")
535 def clearTempOverride(name):
536         del tempOverride[name]
537 def resetTempOverride():
538         tempOverride.clear()
539
540 #########################################################
541 ## Utility functions to calculate common profile values
542 #########################################################
543 def calculateEdgeWidth():
544         wallThickness = getProfileSettingFloat('wall_thickness')
545         nozzleSize = getProfileSettingFloat('nozzle_size')
546         
547         if wallThickness < nozzleSize:
548                 return wallThickness
549
550         lineCount = int(wallThickness / nozzleSize + 0.0001)
551         lineWidth = wallThickness / lineCount
552         lineWidthAlt = wallThickness / (lineCount + 1)
553         if lineWidth > nozzleSize * 1.5:
554                 return lineWidthAlt
555         return lineWidth
556
557 def calculateLineCount():
558         wallThickness = getProfileSettingFloat('wall_thickness')
559         nozzleSize = getProfileSettingFloat('nozzle_size')
560         
561         if wallThickness < nozzleSize:
562                 return 1
563
564         lineCount = int(wallThickness / nozzleSize + 0.0001)
565         lineWidth = wallThickness / lineCount
566         lineWidthAlt = wallThickness / (lineCount + 1)
567         if lineWidth > nozzleSize * 1.5:
568                 return lineCount + 1
569         return lineCount
570
571 def calculateSolidLayerCount():
572         layerHeight = getProfileSettingFloat('layer_height')
573         solidThickness = getProfileSettingFloat('solid_layer_thickness')
574         return int(math.ceil(solidThickness / layerHeight - 0.0001))
575
576 def calculateObjectSizeOffsets():
577         size = 0.0
578         if getProfileSettingFloat('skirt_line_count') > 0:
579                 size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
580         #if getProfileSetting('enable_raft') != 'False':
581         #       size += profile.getProfileSettingFloat('raft_margin') * 2
582         #if getProfileSetting('support') != 'None':
583         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
584         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
585         return [size, size]
586
587 def getMachineCenterCoords():
588         if getPreference('machine_center_is_zero') == 'True':
589                 return [0, 0]
590         return [getPreferenceFloat('machine_width') / 2, getPreferenceFloat('machine_depth') / 2]
591
592 #########################################################
593 ## Alteration file functions
594 #########################################################
595 def replaceTagMatch(m):
596         pre = m.group(1)
597         tag = m.group(2)
598         if tag == 'time':
599                 return pre + time.strftime('%H:%M:%S').encode('utf-8', 'replace')
600         if tag == 'date':
601                 return pre + time.strftime('%d %b %Y').encode('utf-8', 'replace')
602         if tag == 'day':
603                 return pre + time.strftime('%a').encode('utf-8', 'replace')
604         if tag == 'print_time':
605                 return pre + '#P_TIME#'
606         if tag == 'filament_amount':
607                 return pre + '#F_AMNT#'
608         if tag == 'filament_weight':
609                 return pre + '#F_WGHT#'
610         if tag == 'filament_cost':
611                 return pre + '#F_COST#'
612         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
613                 f = getProfileSettingFloat(tag) * 60
614         elif isProfileSetting(tag):
615                 f = getProfileSettingFloat(tag)
616         elif isPreference(tag):
617                 f = getProfileSettingFloat(tag)
618         else:
619                 return '%s?%s?' % (pre, tag)
620         if (f % 1) == 0:
621                 return pre + str(int(f))
622         return pre + str(f)
623
624 def replaceGCodeTags(filename, gcodeInt):
625         f = open(filename, 'r+')
626         data = f.read(2048)
627         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
628         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
629         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
630         cost = gcodeInt.calculateCost()
631         if cost is None:
632                 cost = 'Unknown'
633         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
634         f.seek(0)
635         f.write(data)
636         f.close()
637
638 ### Get aleration raw contents. (Used internally in Cura)
639 def getAlterationFile(filename):
640         if filename in tempOverride:
641                 return tempOverride[filename]
642         global settingsDictionary
643         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
644                 return settingsDictionary[filename].getValue()
645         print 'Error: "%s" not found in profile settings' % (filename)
646         return ''
647
648 def setAlterationFile(name, value):
649         #Check if we have a configuration file loaded, else load the default.
650         global settingsDictionary
651         if name in settingsDictionary and settingsDictionary[name].isAlteration():
652                 settingsDictionary[name].setValue(value)
653         saveProfile(getDefaultProfilePath())
654
655 ### Get the alteration file for output. (Used by Skeinforge)
656 def getAlterationFileContents(filename, extruderCount = 1):
657         prefix = ''
658         postfix = ''
659         alterationContents = getAlterationFile(filename)
660         if filename == 'start.gcode':
661                 #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.
662                 #We also set our steps per E here, if configured.
663                 eSteps = getPreferenceFloat('steps_per_e')
664                 if eSteps > 0:
665                         prefix += 'M92 E%f\n' % (eSteps)
666                 temp = getProfileSettingFloat('print_temperature')
667                 bedTemp = 0
668                 if getPreference('has_heated_bed') == 'True':
669                         bedTemp = getProfileSettingFloat('print_bed_temperature')
670                 
671                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
672                         prefix += 'M140 S%f\n' % (bedTemp)
673                 if temp > 0 and not '{print_temperature}' in alterationContents:
674                         if extruderCount > 0:
675                                 for n in xrange(1, extruderCount):
676                                         t = temp
677                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
678                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
679                                         prefix += 'M104 T%d S%f\n' % (n, temp)
680                                 for n in xrange(0, extruderCount):
681                                         t = temp
682                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
683                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
684                                         prefix += 'M109 T%d S%f\n' % (n, temp)
685                                 prefix += 'T0\n'
686                         else:
687                                 prefix += 'M109 S%f\n' % (temp)
688                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
689                         prefix += 'M190 S%f\n' % (bedTemp)
690         elif filename == 'end.gcode':
691                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
692                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
693         elif filename == 'replace.csv':
694                 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.
695                 prefix = 'M101\nM103\n'
696         elif filename == 'support_start.gcode' or filename == 'support_end.gcode':
697                 #Add support start/end code 
698                 if getProfileSetting('support_dual_extrusion') == 'True' and int(getPreference('extruder_amount')) > 1:
699                         if filename == 'support_start.gcode':
700                                 setTempOverride('extruder', '1')
701                         else:
702                                 setTempOverride('extruder', '0')
703                         alterationContents = getAlterationFileContents('switchExtruder.gcode')
704                         clearTempOverride('extruder')
705                 else:
706                         alterationContents = ''
707         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
708
709 ###### PLUGIN #####
710
711 def getPluginConfig():
712         try:
713                 return pickle.loads(getProfileSetting('plugin_config'))
714         except:
715                 return []
716
717 def setPluginConfig(config):
718         putProfileSetting('plugin_config', pickle.dumps(config))
719
720 def getPluginBasePaths():
721         ret = []
722         if platform.system() != "Windows":
723                 ret.append(os.path.expanduser('~/.cura/plugins/'))
724         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
725                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
726         else:
727                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
728         return ret
729
730 def getPluginList():
731         ret = []
732         for basePath in getPluginBasePaths():
733                 for filename in glob.glob(os.path.join(basePath, '*.py')):
734                         filename = os.path.basename(filename)
735                         if filename.startswith('_'):
736                                 continue
737                         with open(os.path.join(basePath, filename), "r") as f:
738                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
739                                 for line in f:
740                                         line = line.strip()
741                                         if not line.startswith('#'):
742                                                 break
743                                         line = line[1:].split(':', 1)
744                                         if len(line) != 2:
745                                                 continue
746                                         if line[0].upper() == 'NAME':
747                                                 item['name'] = line[1].strip()
748                                         elif line[0].upper() == 'INFO':
749                                                 item['info'] = line[1].strip()
750                                         elif line[0].upper() == 'TYPE':
751                                                 item['type'] = line[1].strip()
752                                         elif line[0].upper() == 'DEPEND':
753                                                 pass
754                                         elif line[0].upper() == 'PARAM':
755                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
756                                                 if m is not None:
757                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
758                                         else:
759                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
760                                 if item['name'] is not None and item['type'] == 'postprocess':
761                                         ret.append(item)
762         return ret
763
764 def runPostProcessingPlugins(gcodefilename):
765         pluginConfigList = getPluginConfig()
766         pluginList = getPluginList()
767         
768         for pluginConfig in pluginConfigList:
769                 plugin = None
770                 for pluginTest in pluginList:
771                         if pluginTest['filename'] == pluginConfig['filename']:
772                                 plugin = pluginTest
773                 if plugin is None:
774                         continue
775                 
776                 pythonFile = None
777                 for basePath in getPluginBasePaths():
778                         testFilename = os.path.join(basePath, pluginConfig['filename'])
779                         if os.path.isfile(testFilename):
780                                 pythonFile = testFilename
781                 if pythonFile is None:
782                         continue
783                 
784                 locals = {'filename': gcodefilename}
785                 for param in plugin['params']:
786                         value = param['default']
787                         if param['name'] in pluginConfig['params']:
788                                 value = pluginConfig['params'][param['name']]
789                         
790                         if param['type'] == 'float':
791                                 try:
792                                         value = float(value)
793                                 except:
794                                         value = float(param['default'])
795                         
796                         locals[param['name']] = value
797                 try:
798                         execfile(pythonFile, locals)
799                 except:
800                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
801                         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])
802         return None