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