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