chiark / gitweb /
Split the scene logic into another file, so we can add auto-placement there without...
[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 structure').setLabel('Support type', 'Type of support structure build.\n"Exterior only" is the most commonly used support setting.\n\nNone does not do any support.\nTouching buildplate only creates support where the support structure will touch the build platform.\nEverywhere creates support even on top of parts of the model.')
128 setting('enable_raft',             False, bool,  'basic',   'Support').setLabel('Enable raft', 'A raft is a few layers of lines below the bottom of the object. It prevents warping. Full raft settings can be found in the expert settings.\nFor PLA this is usually not required. But if you print with ABS it is almost required.')
129 setting('support_dual_extrusion',  False, bool, 'basic', 'Support').setLabel('Support dual extrusion', 'Print the support material with the 2nd extruder in a dual extrusion setup. The primary extruder will be used for normal material, while the second extruder is used to print support material.')
130 setting('filament_diameter',        2.89, float, 'basic',    'Filament').setRange(1).setLabel('Diameter (mm)', 'Diameter of your filament, as accurately as possible.\nIf you cannot measure this value you will have to calibrate it, a higher number means less extrusion, a smaller number generates more extrusion.')
131 setting('filament_diameter2',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter2 (mm)', 'Diameter of your filament for the 2nd nozzle. Use 0 to use the same diameter as for nozzle 1.')
132 setting('filament_diameter3',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter3 (mm)', 'Diameter of your filament for the 3th nozzle. Use 0 to use the same diameter as for nozzle 1.')
133 setting('filament_diameter4',          0, float, 'basic',    'Filament').setRange(0).setLabel('Diameter4 (mm)', 'Diameter of your filament for the 4th nozzle. Use 0 to use the same diameter as for nozzle 1.')
134 setting('filament_density',         1.00, float, 'basic',    'Filament').setRange(0.5,1.5).setLabel('Packing Density', 'Packing density of your filament. This should be 1.00 for PLA and 0.85 for ABS')
135 setting('retraction_min_travel',     5.0, float, 'advanced', 'Retraction').setRange(0).setLabel('Minimum travel (mm)', 'Minimum amount of travel needed for a retraction to happen at all. To make sure you do not get a lot of retractions in a small area')
136 setting('retraction_speed',         40.0, float, 'advanced', 'Retraction').setRange(0.1).setLabel('Speed (mm/s)', 'Speed at which the filament is retracted, a higher retraction speed works better. But a very high retraction speed can lead to filament grinding.')
137 setting('retraction_amount',         4.5, float, 'advanced', 'Retraction').setRange(0).setLabel('Distance (mm)', 'Amount of retraction, set at 0 for no retraction at all. A value of 2.0mm seems to generate good results.')
138 setting('retraction_extra',          0.0, float, 'advanced', 'Retraction').setRange(0).setLabel('Extra length on start (mm)', 'Extra extrusion amount when restarting after a retraction, to better "Prime" your extruder after retraction.')
139 setting('bottom_thickness',          0.3, float, 'advanced', 'Quality').setRange(0).setLabel('Initial layer thickness (mm)', 'Layer thickness of the bottom layer. A thicker bottom layer makes sticking to the bed easier. Set to 0.0 to have the bottom layer thickness the same as the other layers.')
140 setting('object_sink',               0.0, float, 'advanced', 'Quality').setLabel('Cut off object bottom (mm)', 'Sinks the object into the platform, this can be used for objects that do not have a flat bottom and thus create a too small first layer.')
141 setting('enable_skin',             False, bool,  'advanced', 'Quality').setLabel('Duplicate outlines', 'Skin prints the outer lines of the prints twice, each time with half the thickness. This gives the illusion of a higher print quality.')
142 setting('travel_speed',            150.0, float, 'advanced', 'Speed').setRange(0.1).setLabel('Travel speed (mm/s)', 'Speed at which travel moves are done, a high quality build Ultimaker can reach speeds of 250mm/s. But some machines might miss steps then.')
143 setting('bottom_layer_speed',         20, float, 'advanced', 'Speed').setRange(0.1).setLabel('Bottom layer speed (mm/s)', 'Print speed for the bottom layer, you want to print the first layer slower so it sticks better to the printer bed.')
144 #setting('cool_min_layer_time',         5, float, 'advanced', 'Cool').setRange(0).setLabel('Minimal layer time (sec)', 'Minimum time spend in a layer, gives the layer time to cool down before the next layer is put on top. If the layer will be placed down too fast the printer will slow down to make sure it has spend at least this amount of seconds printing this layer.')
145 #setting('fan_enabled',              True, bool,  'advanced', 'Cool').setLabel('Enable cooling fan', 'Enable the cooling fan during the print. The extra cooling from the cooling fan is essensial during faster prints.')
146 #setting('max_z_speed',               3.0, float, 'expert',   'Speed').setRange(0.1).setLabel('Max Z speed (mm/s)', 'Speed at which Z moves are done. When you Z axis is properly lubricated you can increase this for less Z blob.')
147 #setting('retract_on_jumps_only',    True, bool,  'expert',   'Retraction').setLabel('Retract on jumps only', 'Only retract when we are making a move that is over a hole in the model, else retract on every move. This effects print quality in different ways.')
148 setting('fan_layer',                   1, int,   'expert',   'Cool').setRange(0).setLabel('Fan on layer number', 'The layer at which the fan is turned on. The first layer is layer 0. The first layer can stick better if you turn on the fan on, on the 2nd layer.')
149 #setting('fan_speed',                 100, int,   'expert',   'Cool').setRange(0,100).setLabel('Fan speed min (%)', 'When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Minimal fan speed is used if the layer is not slowed down due to cooling.')
150 #setting('fan_speed_max',             100, int,   'expert',   'Cool').setRange(0,100).setLabel('Fan speed max (%)', 'When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Maximal fan speed is used if the layer is slowed down due to cooling by more then 200%.')
151 #setting('cool_min_feedrate',          10, float, 'expert',   'Cool').setRange(0).setLabel('Minimum feedrate (mm/s)', 'The minimal layer time can cause the print to slow down so much it starts to ooze. The minimal feedrate protects against this. Even if a print gets slown down it will never be slower then this minimal feedrate.')
152 #setting('extra_base_wall_thickness', 0.0, float, 'expert',   'Accuracy').setRange(0).setLabel('Extra Wall thickness for bottom/top (mm)', 'Additional wall thickness of the bottom and top layers.')
153 #setting('sequence', 'Loops > Perimeter > Infill', ['Loops > Perimeter > Infill', 'Loops > Infill > Perimeter', 'Infill > Loops > Perimeter', 'Infill > Perimeter > Loops', 'Perimeter > Infill > Loops', 'Perimeter > Loops > Infill'], 'expert', 'Sequence')
154 #setting('force_first_layer_sequence', True, bool, 'expert', 'Sequence').setLabel('Force first layer sequence', 'This setting forces the order of the first layer to be \'Perimeter > Loops > Infill\'')
155 #setting('infill_type', 'Line', ['Line', 'Grid Circular', 'Grid Hexagonal', 'Grid Rectangular'], 'expert', 'Infill').setLabel('Infill pattern', 'Pattern of the none-solid infill. Line is default, but grids can provide a strong print.')
156 #setting('solid_top', True, bool, 'expert', 'Infill').setLabel('Solid infill top', 'Create a solid top surface, if set to false the top is filled with the fill percentage. Useful for cups/vases.')
157 #setting('fill_overlap', 15, int, 'expert', 'Infill').setRange(0,100).setLabel('Infill overlap (%)', 'Amount of overlap between the infill and the walls. There is a slight overlap with the walls and the infill so the walls connect firmly to the infill.')
158 #setting('support_rate', 50, int, 'expert', 'Support').setRange(0,100).setLabel('Material amount (%)', 'Amount of material used for support, less material gives a weaker support structure which is easier to remove.')
159 #setting('support_distance',  0.5, float, 'expert', 'Support').setRange(0).setLabel('Distance from object (mm)', 'Distance between the support structure and the object. Empty gap in which no support structure is printed.')
160 #setting('joris', False, bool, 'expert', 'Joris').setLabel('Spiralize the outer contour', '[Joris] is a code name for smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. It is intended to be used with a single walled wall thickness to make cups/vases.')
161 #setting('bridge_speed', 100, int, 'expert', 'Bridge').setRange(0,100).setLabel('Bridge speed (%)', 'Speed at which layers with bridges are printed, compared to normal printing speed.')
162 #setting('raft_margin', 5, float, 'expert', 'Raft').setRange(0).setLabel('Extra margin (mm)', 'If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft.')
163 #setting('raft_base_material_amount', 100, int, 'expert', 'Raft').setRange(0,100).setLabel('Base material amount (%)', 'The base layer is the first layer put down as a raft. This layer has thick strong lines and is put firmly on the bed to prevent warping. This setting adjust the amount of material used for the base layer.')
164 #setting('raft_interface_material_amount', 100, int, 'expert', 'Raft').setRange(0,100).setLabel('Interface material amount (%)', 'The interface layer is a weak thin layer between the base layer and the printed object. It is designed to has little material to make it easy to break the base off the printed object. This setting adjusts the amount of material used for the interface layer.')
165 #setting('hop_on_move', False, bool, 'expert', 'Hop').setLabel('Enable hop on move', 'When moving from print position to print position, raise the printer head 0.2mm so it does not knock off the print (experimental).')
166
167 setting('model_matrix', '1,0,0,0,1,0,0,0,1', str, 'hidden', 'hidden')
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('sdshortnames', 'False', bool, 'preference', 'hidden').setLabel('Copy to SD with 8.3 names', 'Save the gcode files in short filenames, so they are properly shown on the UltiController')
265 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
266 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
267
268 setting('planner_always_autoplace', 'True', bool, 'preference', 'hidden')
269 setting('extruder_head_size_min_x', '75.0', float, 'preference', 'hidden')
270 setting('extruder_head_size_min_y', '18.0', float, 'preference', 'hidden')
271 setting('extruder_head_size_max_x', '18.0', float, 'preference', 'hidden')
272 setting('extruder_head_size_max_y', '35.0', float, 'preference', 'hidden')
273 setting('extruder_head_size_height', '60.0', float, 'preference', 'hidden')
274
275 setting('model_colour', '#7AB645', str, 'preference', 'hidden').setLabel('Model colour')
276 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
277 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
278 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
279
280 setting('window_maximized', 'False', bool, 'preference', 'hidden')
281 setting('window_pos_x', '-1', float, 'preference', 'hidden')
282 setting('window_pos_y', '-1', float, 'preference', 'hidden')
283 setting('window_width', '-1', float, 'preference', 'hidden')
284 setting('window_height', '-1', float, 'preference', 'hidden')
285 setting('window_normal_sash', '320', float, 'preference', 'hidden')
286
287 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.")
288 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
289 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
290 validators.printSpeedValidator(settingsDictionary['print_speed'])
291 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
292 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
293 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
294 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
295 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
296 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
297 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
298 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
299 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
300 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.")
301
302 #Conditions for multiple extruders
303 settingsDictionary['print_temperature2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
304 settingsDictionary['print_temperature3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
305 settingsDictionary['print_temperature4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
306 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
307 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
308 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
309 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
310 #Heated bed
311 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('has_heated_bed') == 'True')
312
313 #########################################################
314 ## Profile and preferences functions
315 #########################################################
316
317 def getSubCategoriesFor(category):
318         done = {}
319         ret = []
320         for s in settingsList:
321                 if s.getCategory() == category and not s.getSubCategory() in done:
322                         done[s.getSubCategory()] = True
323                         ret.append(s.getSubCategory())
324         return ret
325
326 def getSettingsForCategory(category, subCategory = None):
327         ret = []
328         for s in settingsList:
329                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory):
330                         ret.append(s)
331         return ret
332
333 ## Profile functions
334 def getBasePath():
335         if platform.system() == "Windows":
336                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
337                 #If we have a frozen python install, we need to step out of the library.zip
338                 if hasattr(sys, 'frozen'):
339                         basePath = os.path.normpath(os.path.join(basePath, ".."))
340         else:
341                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
342         if not os.path.isdir(basePath):
343                 os.makedirs(basePath)
344         return basePath
345
346 def getDefaultProfilePath():
347         return os.path.join(getBasePath(), 'current_profile.ini')
348
349 def loadProfile(filename):
350         #Read a configuration file as global config
351         profileParser = ConfigParser.ConfigParser()
352         try:
353                 profileParser.read(filename)
354         except ConfigParser.ParsingError:
355                 return
356         global settingsList
357         for set in settingsList:
358                 if set.isPreference():
359                         continue
360                 section = 'profile'
361                 if set.isAlteration():
362                         section = 'alterations'
363                 if profileParser.has_option(section, set.getName()):
364                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
365
366 def saveProfile(filename):
367         #Save the current profile to an ini file
368         profileParser = ConfigParser.ConfigParser()
369         profileParser.add_section('profile')
370         profileParser.add_section('alterations')
371         global settingsList
372         for set in settingsList:
373                 if set.isPreference():
374                         continue
375                 if set.isAlteration():
376                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
377                 else:
378                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
379
380         profileParser.write(open(filename, 'w'))
381
382 def resetProfile():
383         #Read a configuration file as global config
384         global settingsList
385         for set in settingsList:
386                 if set.isPreference():
387                         continue
388                 set.setValue(set.getDefault())
389
390         if getPreference('machine_type') == 'ultimaker':
391                 putProfileSetting('nozzle_size', '0.4')
392                 if getPreference('ultimaker_extruder_upgrade') == 'True':
393                         putProfileSetting('retraction_enable', 'True')
394         else:
395                 putProfileSetting('nozzle_size', '0.5')
396
397 def loadProfileFromString(options):
398         options = base64.b64decode(options)
399         options = zlib.decompress(options)
400         (profileOpts, alt) = options.split('\f', 1)
401         global settingsDictionary
402         for option in profileOpts.split('\b'):
403                 if len(option) > 0:
404                         (key, value) = option.split('=', 1)
405                         if key in settingsDictionary:
406                                 if settingsDictionary[key].isProfile():
407                                         settingsDictionary[key].setValue(value)
408         for option in alt.split('\b'):
409                 if len(option) > 0:
410                         (key, value) = option.split('=', 1)
411                         if key in settingsDictionary:
412                                 if settingsDictionary[key].isAlteration():
413                                         settingsDictionary[key].setValue(value)
414
415 def getProfileString():
416         p = []
417         alt = []
418         global settingsList
419         for set in settingsList:
420                 if set.isProfile():
421                         if set.getName() in tempOverride:
422                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
423                         else:
424                                 p.append(set.getName() + "=" + set.getValue())
425                 if set.isAlteration():
426                         if set.getName() in tempOverride:
427                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
428                         else:
429                                 alt.append(set.getName() + "=" + set.getValue())
430         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
431         ret = base64.b64encode(zlib.compress(ret, 9))
432         return ret
433
434 def getGlobalPreferencesString():
435         p = []
436         global settingsList
437         for set in settingsList:
438                 if set.isPreference():
439                         p.append(set.getName() + "=" + set.getValue())
440         ret = '\b'.join(p)
441         ret = base64.b64encode(zlib.compress(ret, 9))
442         return ret
443
444
445 def getProfileSetting(name):
446         if name in tempOverride:
447                 return tempOverride[name]
448         global settingsDictionary
449         if name in settingsDictionary and settingsDictionary[name].isProfile():
450                 return settingsDictionary[name].getValue()
451         print 'Error: "%s" not found in profile settings' % (name)
452         return ''
453
454 def getProfileSettingFloat(name):
455         try:
456                 setting = getProfileSetting(name).replace(',', '.')
457                 return float(eval(setting, {}, {}))
458         except (ValueError, SyntaxError, TypeError):
459                 return 0.0
460
461 def putProfileSetting(name, value):
462         #Check if we have a configuration file loaded, else load the default.
463         global settingsDictionary
464         if name in settingsDictionary and settingsDictionary[name].isProfile():
465                 settingsDictionary[name].setValue(value)
466
467 def isProfileSetting(name):
468         global settingsDictionary
469         if name in settingsDictionary and settingsDictionary[name].isProfile():
470                 return True
471         return False
472
473 ## Preferences functions
474 def getPreferencePath():
475         return os.path.join(getBasePath(), 'preferences.ini')
476
477 def getPreferenceFloat(name):
478         try:
479                 setting = getPreference(name).replace(',', '.')
480                 return float(eval(setting, {}, {}))
481         except (ValueError, SyntaxError, TypeError):
482                 return 0.0
483
484 def getPreferenceColour(name):
485         colorString = getPreference(name)
486         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
487
488 def loadPreferences(filename):
489         #Read a configuration file as global config
490         profileParser = ConfigParser.ConfigParser()
491         try:
492                 profileParser.read(filename)
493         except ConfigParser.ParsingError:
494                 return
495         global settingsList
496         for set in settingsList:
497                 if set.isPreference():
498                         if profileParser.has_option('preference', set.getName()):
499                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
500
501 def savePreferences(filename):
502         #Save the current profile to an ini file
503         parser = ConfigParser.ConfigParser()
504         parser.add_section('preference')
505         global settingsList
506         for set in settingsList:
507                 if set.isPreference():
508                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
509         parser.write(open(filename, 'w'))
510
511 def getPreference(name):
512         if name in tempOverride:
513                 return tempOverride[name]
514         global settingsDictionary
515         if name in settingsDictionary and settingsDictionary[name].isPreference():
516                 return settingsDictionary[name].getValue()
517         print 'Error: "%s" not found in profile settings' % (name)
518         return ''
519
520 def putPreference(name, value):
521         #Check if we have a configuration file loaded, else load the default.
522         global settingsDictionary
523         if name in settingsDictionary and settingsDictionary[name].isPreference():
524                 settingsDictionary[name].setValue(value)
525         savePreferences(getPreferencePath())
526
527 def isPreference(name):
528         global settingsDictionary
529         if name in settingsDictionary and settingsDictionary[name].isPreference():
530                 return True
531         return False
532
533 ## Temp overrides for multi-extruder slicing and the project planner.
534 tempOverride = {}
535 def setTempOverride(name, value):
536         tempOverride[name] = unicode(value).encode("utf-8")
537 def clearTempOverride(name):
538         del tempOverride[name]
539 def resetTempOverride():
540         tempOverride.clear()
541
542 #########################################################
543 ## Utility functions to calculate common profile values
544 #########################################################
545 def calculateEdgeWidth():
546         wallThickness = getProfileSettingFloat('wall_thickness')
547         nozzleSize = getProfileSettingFloat('nozzle_size')
548         
549         if wallThickness < nozzleSize:
550                 return wallThickness
551
552         lineCount = int(wallThickness / nozzleSize + 0.0001)
553         lineWidth = wallThickness / lineCount
554         lineWidthAlt = wallThickness / (lineCount + 1)
555         if lineWidth > nozzleSize * 1.5:
556                 return lineWidthAlt
557         return lineWidth
558
559 def calculateLineCount():
560         wallThickness = getProfileSettingFloat('wall_thickness')
561         nozzleSize = getProfileSettingFloat('nozzle_size')
562         
563         if wallThickness < nozzleSize:
564                 return 1
565
566         lineCount = int(wallThickness / nozzleSize + 0.0001)
567         lineWidth = wallThickness / lineCount
568         lineWidthAlt = wallThickness / (lineCount + 1)
569         if lineWidth > nozzleSize * 1.5:
570                 return lineCount + 1
571         return lineCount
572
573 def calculateSolidLayerCount():
574         layerHeight = getProfileSettingFloat('layer_height')
575         solidThickness = getProfileSettingFloat('solid_layer_thickness')
576         return int(math.ceil(solidThickness / layerHeight - 0.0001))
577
578 def getMachineCenterCoords():
579         if getPreference('machine_center_is_zero') == 'True':
580                 return [0, 0]
581         return [getPreferenceFloat('machine_width') / 2, getPreferenceFloat('machine_depth') / 2]
582
583 def getObjectMatrix():
584         try:
585                 return map(float, getProfileSetting('model_matrix').split(','))
586         except ValueError:
587                 return [1,0,0, 0,1,0, 0,0,1]
588
589
590 #########################################################
591 ## Alteration file functions
592 #########################################################
593 def replaceTagMatch(m):
594         pre = m.group(1)
595         tag = m.group(2)
596         if tag == 'time':
597                 return pre + time.strftime('%H:%M:%S').encode('utf-8', 'replace')
598         if tag == 'date':
599                 return pre + time.strftime('%d %b %Y').encode('utf-8', 'replace')
600         if tag == 'day':
601                 return pre + time.strftime('%a').encode('utf-8', 'replace')
602         if tag == 'print_time':
603                 return pre + '#P_TIME#'
604         if tag == 'filament_amount':
605                 return pre + '#F_AMNT#'
606         if tag == 'filament_weight':
607                 return pre + '#F_WGHT#'
608         if tag == 'filament_cost':
609                 return pre + '#F_COST#'
610         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
611                 f = getProfileSettingFloat(tag) * 60
612         elif isProfileSetting(tag):
613                 f = getProfileSettingFloat(tag)
614         elif isPreference(tag):
615                 f = getProfileSettingFloat(tag)
616         else:
617                 return '%s?%s?' % (pre, tag)
618         if (f % 1) == 0:
619                 return pre + str(int(f))
620         return pre + str(f)
621
622 def replaceGCodeTags(filename, gcodeInt):
623         f = open(filename, 'r+')
624         data = f.read(2048)
625         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
626         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
627         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
628         cost = gcodeInt.calculateCost()
629         if cost is None:
630                 cost = 'Unknown'
631         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
632         f.seek(0)
633         f.write(data)
634         f.close()
635
636 ### Get aleration raw contents. (Used internally in Cura)
637 def getAlterationFile(filename):
638         if filename in tempOverride:
639                 return tempOverride[filename]
640         global settingsDictionary
641         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
642                 return settingsDictionary[filename].getValue()
643         print 'Error: "%s" not found in profile settings' % (filename)
644         return ''
645
646 def setAlterationFile(name, value):
647         #Check if we have a configuration file loaded, else load the default.
648         global settingsDictionary
649         if name in settingsDictionary and settingsDictionary[name].isAlteration():
650                 settingsDictionary[name].setValue(value)
651         saveProfile(getDefaultProfilePath())
652
653 ### Get the alteration file for output. (Used by Skeinforge)
654 def getAlterationFileContents(filename, extruderCount = 1):
655         prefix = ''
656         postfix = ''
657         alterationContents = getAlterationFile(filename)
658         if filename == 'start.gcode':
659                 #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.
660                 #We also set our steps per E here, if configured.
661                 eSteps = getPreferenceFloat('steps_per_e')
662                 if eSteps > 0:
663                         prefix += 'M92 E%f\n' % (eSteps)
664                 temp = getProfileSettingFloat('print_temperature')
665                 bedTemp = 0
666                 if getPreference('has_heated_bed') == 'True':
667                         bedTemp = getProfileSettingFloat('print_bed_temperature')
668                 
669                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
670                         prefix += 'M140 S%f\n' % (bedTemp)
671                 if temp > 0 and not '{print_temperature}' in alterationContents:
672                         if extruderCount > 0:
673                                 for n in xrange(1, extruderCount):
674                                         t = temp
675                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
676                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
677                                         prefix += 'M104 T%d S%f\n' % (n, temp)
678                                 for n in xrange(0, 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 += 'M109 T%d S%f\n' % (n, temp)
683                                 prefix += 'T0\n'
684                         else:
685                                 prefix += 'M109 S%f\n' % (temp)
686                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
687                         prefix += 'M190 S%f\n' % (bedTemp)
688         elif filename == 'end.gcode':
689                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
690                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
691         elif filename == 'replace.csv':
692                 #Always remove the extruder on/off M codes. These are no longer needed in 5D printing.
693                 prefix = 'M101\nM103\n'
694         elif filename == 'support_start.gcode' or filename == 'support_end.gcode':
695                 #Add support start/end code 
696                 if getProfileSetting('support_dual_extrusion') == 'True' and int(getPreference('extruder_amount')) > 1:
697                         if filename == 'support_start.gcode':
698                                 setTempOverride('extruder', '1')
699                         else:
700                                 setTempOverride('extruder', '0')
701                         alterationContents = getAlterationFileContents('switchExtruder.gcode')
702                         clearTempOverride('extruder')
703                 else:
704                         alterationContents = ''
705         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
706
707 ###### PLUGIN #####
708
709 def getPluginConfig():
710         try:
711                 return pickle.loads(getProfileSetting('plugin_config'))
712         except:
713                 return []
714
715 def setPluginConfig(config):
716         putProfileSetting('plugin_config', pickle.dumps(config))
717
718 def getPluginBasePaths():
719         ret = []
720         if platform.system() != "Windows":
721                 ret.append(os.path.expanduser('~/.cura/plugins/'))
722         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
723                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
724         else:
725                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
726         return ret
727
728 def getPluginList():
729         ret = []
730         for basePath in getPluginBasePaths():
731                 for filename in glob.glob(os.path.join(basePath, '*.py')):
732                         filename = os.path.basename(filename)
733                         if filename.startswith('_'):
734                                 continue
735                         with open(os.path.join(basePath, filename), "r") as f:
736                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
737                                 for line in f:
738                                         line = line.strip()
739                                         if not line.startswith('#'):
740                                                 break
741                                         line = line[1:].split(':', 1)
742                                         if len(line) != 2:
743                                                 continue
744                                         if line[0].upper() == 'NAME':
745                                                 item['name'] = line[1].strip()
746                                         elif line[0].upper() == 'INFO':
747                                                 item['info'] = line[1].strip()
748                                         elif line[0].upper() == 'TYPE':
749                                                 item['type'] = line[1].strip()
750                                         elif line[0].upper() == 'DEPEND':
751                                                 pass
752                                         elif line[0].upper() == 'PARAM':
753                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
754                                                 if m is not None:
755                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
756                                         else:
757                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
758                                 if item['name'] != None and item['type'] == 'postprocess':
759                                         ret.append(item)
760         return ret
761
762 def runPostProcessingPlugins(gcodefilename):
763         pluginConfigList = getPluginConfig()
764         pluginList = getPluginList()
765         
766         for pluginConfig in pluginConfigList:
767                 plugin = None
768                 for pluginTest in pluginList:
769                         if pluginTest['filename'] == pluginConfig['filename']:
770                                 plugin = pluginTest
771                 if plugin is None:
772                         continue
773                 
774                 pythonFile = None
775                 for basePath in getPluginBasePaths():
776                         testFilename = os.path.join(basePath, pluginConfig['filename'])
777                         if os.path.isfile(testFilename):
778                                 pythonFile = testFilename
779                 if pythonFile is None:
780                         continue
781                 
782                 locals = {'filename': gcodefilename}
783                 for param in plugin['params']:
784                         value = param['default']
785                         if param['name'] in pluginConfig['params']:
786                                 value = pluginConfig['params'][param['name']]
787                         
788                         if param['type'] == 'float':
789                                 try:
790                                         value = float(value)
791                                 except:
792                                         value = float(param['default'])
793                         
794                         locals[param['name']] = value
795                 try:
796                         execfile(pythonFile, locals)
797                 except:
798                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
799                         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])
800         return None
801
802 def getSDcardDrives():
803         drives = ['']
804         if platform.system() == "Windows":
805                 from ctypes import windll
806                 bitmask = windll.kernel32.GetLogicalDrives()
807                 for letter in string.uppercase:
808                         if bitmask & 1:
809                                 drives.append(letter + ':/')
810                         bitmask >>= 1
811         if platform.system() == "Darwin":
812                 drives = []
813                 for volume in glob.glob('/Volumes/*'):
814                         if stat.S_ISLNK(os.lstat(volume).st_mode):
815                                 continue
816                         drives.append(volume)
817         return drives