chiark / gitweb /
Add option to add/remove machines from machine setting menu.
[cura.git] / Cura / util / profile.py
1 from __future__ import absolute_import
2 from __future__ import division
3 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
4
5 import os, traceback, math, re, zlib, base64, time, sys, platform, glob, string, stat, types
6 import cPickle as pickle
7 if sys.version_info[0] < 3:
8         import ConfigParser
9 else:
10         import configparser as ConfigParser
11
12 from Cura.util import resources
13 from Cura.util import version
14 from Cura.util import validators
15
16 #The settings dictionary contains a key/value reference to all possible settings. With the setting name as key.
17 settingsDictionary = {}
18 #The settings list is used to keep a full list of all the settings. This is needed to keep the settings in the proper order,
19 # as the dictionary will not contain insertion order.
20 settingsList = []
21
22 #Currently selected machine (by index) Cura support multiple machines in the same preferences and can switch between them.
23 # Each machine has it's own index and unique name.
24 _selectedMachineIndex = 0
25
26 class setting(object):
27         #A setting object contains a configuration setting. These are globally accessible trough the quick access functions
28         # and trough the settingsDictionary function.
29         # Settings can be:
30         # * profile settings (settings that effect the slicing process and the print result)
31         # * preferences (settings that effect how cura works and acts)
32         # * machine settings (settings that relate to the physical configuration of your machine)
33         # * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
34         # Settings have validators that check if the value is valid, but do not prevent invalid values!
35         # Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
36         def __init__(self, name, default, type, category, subcategory):
37                 self._name = name
38                 self._label = name
39                 self._tooltip = ''
40                 self._default = unicode(default)
41                 self._values = []
42                 self._type = type
43                 self._category = category
44                 self._subcategory = subcategory
45                 self._validators = []
46                 self._conditions = []
47
48                 if type is types.FloatType:
49                         validators.validFloat(self)
50                 elif type is types.IntType:
51                         validators.validInt(self)
52
53                 global settingsDictionary
54                 settingsDictionary[name] = self
55                 global settingsList
56                 settingsList.append(self)
57
58         def setLabel(self, label, tooltip = ''):
59                 self._label = label
60                 self._tooltip = tooltip
61                 return self
62
63         def setRange(self, minValue=None, maxValue=None):
64                 if len(self._validators) < 1:
65                         return
66                 self._validators[0].minValue = minValue
67                 self._validators[0].maxValue = maxValue
68                 return self
69
70         def getLabel(self):
71                 return _(self._label)
72
73         def getTooltip(self):
74                 return _(self._tooltip)
75
76         def getCategory(self):
77                 return self._category
78
79         def getSubCategory(self):
80                 return self._subcategory
81
82         def isPreference(self):
83                 return self._category == 'preference'
84
85         def isMachineSetting(self):
86                 return self._category == 'machine'
87
88         def isAlteration(self):
89                 return self._category == 'alteration'
90
91         def isProfile(self):
92                 return not self.isAlteration() and not self.isPreference() and not self.isMachineSetting()
93
94         def getName(self):
95                 return self._name
96
97         def getType(self):
98                 return self._type
99
100         def getValue(self, index = None):
101                 if index is None:
102                         index = self.getValueIndex()
103                 if index >= len(self._values):
104                         return self._default
105                 return self._values[index]
106
107         def getDefault(self):
108                 return self._default
109
110         def setValue(self, value, index = None):
111                 if index is None:
112                         index = self.getValueIndex()
113                 while index >= len(self._values):
114                         self._values.append(self._default)
115                 self._values[index] = unicode(value)
116
117         def getValueIndex(self):
118                 if self.isMachineSetting():
119                         global _selectedMachineIndex
120                         return _selectedMachineIndex
121                 return 0
122
123         def validate(self):
124                 result = validators.SUCCESS
125                 msgs = []
126                 for validator in self._validators:
127                         res, err = validator.validate()
128                         if res == validators.ERROR:
129                                 result = res
130                         elif res == validators.WARNING and result != validators.ERROR:
131                                 result = res
132                         if res != validators.SUCCESS:
133                                 msgs.append(err)
134                 return result, '\n'.join(msgs)
135
136         def addCondition(self, conditionFunction):
137                 self._conditions.append(conditionFunction)
138
139         def checkConditions(self):
140                 for condition in self._conditions:
141                         if not condition():
142                                 return False
143                 return True
144
145 #########################################################
146 ## Settings
147 #########################################################
148 setting('layer_height',              0.1, float, 'basic',    'Quality').setRange(0.0001).setLabel("Layer height (mm)", "Layer height in millimeters.\nThis is the most important setting to determine the quality of your print. Normal quality prints are 0.1mm, high quality is 0.06mm. You can go up to 0.25mm with an Ultimaker for very fast prints at low quality.")
149 setting('wall_thickness',            0.8, float, 'basic',    'Quality').setRange(0.0).setLabel("Shell thickness (mm)", "Thickness of the outside shell in the horizontal direction.\nThis is used in combination with the nozzle size to define the number\nof perimeter lines and the thickness of those perimeter lines.")
150 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.")
151 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 multiple of the layer thickness makes sense. And keep it near your wall thickness to make an evenly strong part.")
152 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.")
153 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.")
154 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.")
155 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.")
156 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.")
157 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.")
158 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.")
159 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.")
160 setting('support',                'None', ['None', 'Touching buildplate', 'Everywhere'], 'basic', 'Support').setLabel("Support type", "Type of support structure build.\n\"Touching buildplate\" is the most commonly used support setting.\n\nNone does not do any support.\nTouching buildplate only creates support where the support structure will touch the build platform.\nEverywhere creates support even on top of parts of the model.")
161 setting('platform_adhesion',      'None', ['None', 'Brim', 'Raft'], 'basic', 'Support').setLabel("Platform adhesion type", "Different options that help in preventing corners from lifting due to warping.\nBrim adds a single layer thick flat area around your object which is easy to cut off afterwards, and the recommended option.\nRaft adds a thick raster at below the object and a thin interface between this and your object.\n(Note that enabling the brim or raft disables the skirt)")
162 setting('support_dual_extrusion',  'Both', ['Both', 'First extruder', 'Second extruder'], 'basic', 'Support').setLabel("Support dual extrusion", "Which extruder to use for support material, for break-away support you can use both extruders.\nBut if one of the materials is more expensive then the other you could select an extruder to use for support material. This causes more extruder switches.\nYou can also use the 2nd extruder for soluble support materials.")
163 setting('filament_diameter',        2.85, float, 'basic',    'Filament').setRange(1).setLabel("Diameter (mm)", "Diameter of your filament, as accurately as possible.\nIf you cannot measure this value you will have to calibrate it, a higher number means less extrusion, a smaller number generates more extrusion.")
164 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.")
165 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.")
166 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.")
167 setting('filament_flow',            100., float, 'basic',    'Filament').setRange(1,300).setLabel("Flow (%)", "Flow compensation, the amount of material extruded is multiplied by this value")
168 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.")
169 setting('retraction_amount',         4.5, float, 'advanced', 'Retraction').setRange(0).setLabel("Distance (mm)", "Amount of retraction, set at 0 for no retraction at all. A value of 4.5mm seems to generate good results.")
170 setting('retraction_dual_amount',   16.5, float, 'advanced', 'Retraction').setRange(0).setLabel("Dual extrusion switch amount (mm)", "Amount of retraction when switching nozzle with dual-extrusion, set at 0 for no retraction at all. A value of 16.0mm seems to generate good results.")
171 setting('retraction_min_travel',     1.5, float, 'expert',   'Retraction').setRange(0).setLabel("Minimum travel (mm)", "Minimum amount of travel needed for a retraction to happen at all. To make sure you do not get a lot of retractions in a small area.")
172 setting('retraction_combing',       True, bool,  'expert',   'Retraction').setLabel("Enable combing", "Combing is the act of avoiding holes in the print for the head to travel over. If combing is disabled the printer head moves straight from the start point to the end point and it will always retract.")
173 setting('retraction_minimal_extrusion',0.5, float,'expert',  'Retraction').setRange(0).setLabel("Minimal extrusion before retracting (mm)", "The minimal amount of extrusion that needs to be done before retracting again if a retraction needs to happen before this minimal is reached the retraction is ignored.\nThis avoids retraction a lot on the same piece of filament which flattens the filament and causes grinding issues.")
174 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.")
175 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.")
176 #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.')
177 setting('overlap_dual',              0.2, float, 'advanced', 'Quality').setLabel("Dual extrusion overlap (mm)", "Add a certain amount of overlapping extrusion on dual-extrusion prints. This bonds the different colors better together.")
178 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.")
179 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.")
180 setting('infill_speed',              0.0, float, 'advanced', 'Speed').setRange(0.0).setLabel("Infill speed (mm/s)", "Speed at which infill parts are printed. If set to 0 then the print speed is used for the infill. Printing the infill faster can greatly reduce printing, but this can negatively effect print quality..")
181 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.")
182 setting('fan_enabled',              True, bool,  'advanced', 'Cool').setLabel("Enable cooling fan", "Enable the cooling fan during the print. The extra cooling from the cooling fan is essential during faster prints.")
183
184 setting('skirt_line_count',            1, int,   'expert', 'Skirt').setRange(0).setLabel("Line count", "The skirt is a line drawn around the object at the first layer. This helps to prime your extruder, and to see if the object fits on your platform.\nSetting this to 0 will disable the skirt. Multiple skirt lines can help priming your extruder better for small objects.")
185 setting('skirt_gap',                 3.0, float, 'expert', 'Skirt').setRange(0).setLabel("Start distance (mm)", "The distance between the skirt and the first layer.\nThis is the minimal distance, multiple skirt lines will be put outwards from this distance.")
186 setting('skirt_minimal_length',    150.0, float, 'expert', 'Skirt').setRange(0).setLabel("Minimal length (mm)", "The minimal length of the skirt, if this minimal length is not reached it will add more skirt lines to reach this minimal lenght.\nNote: If the line count is set to 0 this is ignored.")
187 #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.')
188 #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.')
189 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.")
190 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.")
191 setting('fan_speed_max',             100, int,   'expert',   'Cool').setRange(0,100).setLabel("Fan speed max (%)", "When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Maximal fan speed is used if the layer is slowed down due to cooling by more than 200%.")
192 setting('cool_min_feedrate',          10, float, 'expert',   'Cool').setRange(0).setLabel("Minimum speed (mm/s)", "The minimal layer time can cause the print to slow down so much it starts to ooze. The minimal feedrate protects against this. Even if a print gets slown down it will never be slower than this minimal speed.")
193 setting('cool_head_lift',          False, bool,  'expert',   'Cool').setLabel("Cool head lift", "Lift the head if the minimal speed is hit because of cool slowdown, and wait the extra time so the minimal layer time is always hit.")
194 #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.')
195 #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')
196 #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\'')
197 #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.')
198 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.")
199 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.")
200 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.")
201 setting('support_fill_rate', 20, int, 'expert', 'Support').setRange(0,100).setLabel("Fill amount (%)", "Amount of infill structure in the support material, less material gives weaker support which is easier to remove. 20% seems to be a good average.")
202 setting('support_xy_distance', 0.7, float, 'expert', 'Support').setRange(0,10).setLabel("Distance X/Y (mm)", "Distance of the support material from the print, in the X/Y directions.\n0.7mm gives a nice distance from the print so the support does not stick to the print.")
203 setting('support_z_distance', 0.15, float, 'expert', 'Support').setRange(0,10).setLabel("Distance Z (mm)", "Distance from the top/bottom of the support to the print. A small gap here makes it easier to remove the support but makes the print a bit uglier.\n0.15mm gives a good seperation of the support material.")
204 #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.')
205 #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.')
206 #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.')
207 setting('brim_line_count', 20, int, 'expert', 'Brim').setRange(1,100).setLabel("Brim line amount", "The amount of lines used for a brim, more lines means a larger brim which sticks better, but this also makes your effective print area smaller.")
208 setting('raft_margin', 5, float, 'expert', 'Raft').setRange(0).setLabel("Extra margin (mm)", "If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft while using more material and leaving less are for your print.")
209 setting('raft_line_spacing', 1.0, float, 'expert', 'Raft').setRange(0).setLabel("Line spacing (mm)", "When you are using the raft this is the distance between the centerlines of the raft line.")
210 setting('raft_base_thickness', 0.3, float, 'expert', 'Raft').setRange(0).setLabel("Base thickness (mm)", "When you are using the raft this is the thickness of the base layer which is put down.")
211 setting('raft_base_linewidth', 0.7, float, 'expert', 'Raft').setRange(0).setLabel("Base line width (mm)", "When you are using the raft this is the width of the base layer lines which are put down.")
212 setting('raft_interface_thickness', 0.2, float, 'expert', 'Raft').setRange(0).setLabel("Interface thickness (mm)", "When you are using the raft this is the thickness of the interface layer which is put down.")
213 setting('raft_interface_linewidth', 0.2, float, 'expert', 'Raft').setRange(0).setLabel("Interface line width (mm)", "When you are using the raft this is the width of the interface layer lines which are put down.")
214 #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).')
215 setting('fix_horrible_union_all_type_a', False, bool, 'expert', 'Fix horrible').setLabel("Combine everything (Type-A)", "This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer.")
216 setting('fix_horrible_union_all_type_b', False, bool, 'expert', 'Fix horrible').setLabel("Combine everything (Type-B)", "This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer.")
217 setting('fix_horrible_use_open_bits', False, bool, 'expert', 'Fix horrible').setLabel("Keep open faces", "This expert option keeps all the open bits of the model intact. Normally Cura tries to stitch up small holes and remove everything with big holes, but this option keeps bits that are not properly part of anything and just goes with whatever it is left. This option is usually not what you want, but it might enable you to slice models otherwise failing to produce proper paths.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk.")
218 setting('fix_horrible_extensive_stitching', False, bool, 'expert', 'Fix horrible').setLabel("Extensive stitching", "Extrensive stitching tries to fix up open holes in the model by closing the hole with touching polygons. This algorthm is quite expensive and could introduce a lot of processing time.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk.")
219
220 setting('plugin_config', '', str, 'hidden', 'hidden')
221 setting('object_center_x', -1, float, 'hidden', 'hidden')
222 setting('object_center_y', -1, float, 'hidden', 'hidden')
223
224 setting('start.gcode', """;Sliced at: {day} {date} {time}
225 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
226 ;Print time: {print_time}
227 ;Filament used: {filament_amount}m {filament_weight}g
228 ;Filament cost: {filament_cost}
229 G21        ;metric values
230 G90        ;absolute positioning
231 M107       ;start with the fan off
232
233 G28 X0 Y0  ;move X/Y to min endstops
234 G28 Z0     ;move Z to min endstops
235
236 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
237
238 G92 E0                  ;zero the extruded length
239 G1 F200 E3              ;extrude 3mm of feed stock
240 G92 E0                  ;zero the extruded length again
241 G1 F{travel_speed}
242 M117 Printing...
243 """, str, 'alteration', 'alteration')
244 #######################################################################################
245 setting('end.gcode', """;End GCode
246 M104 S0                     ;extruder heater off
247 M140 S0                     ;heated bed heater off (if you have it)
248
249 G91                                    ;relative positioning
250 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
251 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
252 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
253
254 M84                         ;steppers off
255 G90                         ;absolute positioning
256 """, str, 'alteration', 'alteration')
257 #######################################################################################
258 setting('start2.gcode', """;Sliced at: {day} {date} {time}
259 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
260 ;Print time: {print_time}
261 ;Filament used: {filament_amount}m {filament_weight}g
262 ;Filament cost: {filament_cost}
263 G21        ;metric values
264 G90        ;absolute positioning
265 M107       ;start with the fan off
266
267 G28 X0 Y0  ;move X/Y to min endstops
268 G28 Z0     ;move Z to min endstops
269
270 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
271
272 T1
273 G92 E0                  ;zero the extruded length
274 G1 F200 E10             ;extrude 10mm of feed stock
275 G92 E0                  ;zero the extruded length again
276 G1 F200 E-{retraction_dual_amount}
277
278 T0
279 G92 E0                  ;zero the extruded length
280 G1 F200 E10              ;extrude 10mm of feed stock
281 G92 E0                  ;zero the extruded length again
282 G1 F{travel_speed}
283 M117 Printing...
284 """, str, 'alteration', 'alteration')
285 #######################################################################################
286 setting('end2.gcode', """;End GCode
287 M104 T0 S0                     ;extruder heater off
288 M104 T1 S0                     ;extruder heater off
289 M140 S0                     ;heated bed heater off (if you have it)
290
291 G91                                    ;relative positioning
292 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
293 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
294 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
295
296 M84                         ;steppers off
297 G90                         ;absolute positioning
298 """, str, 'alteration', 'alteration')
299 #######################################################################################
300 setting('support_start.gcode', '', str, 'alteration', 'alteration')
301 setting('support_end.gcode', '', str, 'alteration', 'alteration')
302 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
303 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
304 setting('replace.csv', '', str, 'alteration', 'alteration')
305 #######################################################################################
306 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.
307 G92 E0
308
309 G91                                    ;relative positioning
310 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
311 G1 Z+0.5 E-5 F{travel_speed}           ;move Z up a bit and retract filament even more
312 G90                                    ;absolute positioning
313
314 G1 Z{clear_z} F{max_z_speed}
315 G92 E0
316 G1 X{object_center_x} Y{object_center_y} F{travel_speed}
317 G1 F200 E6
318 G92 E0
319 """, str, 'alteration', 'alteration')
320 #######################################################################################
321 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
322 G92 E0
323 G1 E-36 F5000
324 G92 E0
325 T{extruder}
326 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
327 G1 E36 F5000
328 G92 E0
329 """, str, 'alteration', 'alteration')
330
331 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
332 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
333 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.')
334 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.')
335 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.')
336 setting('auto_detect_sd', 'True', bool, 'preference', 'hidden').setLabel('Auto detect SD card drive', 'Auto detect the SD card. You can disable this because on some systems external hard-drives or USB sticks are detected as SD card.')
337 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
338 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
339 setting('youmagine_token', '', str, 'preference', 'hidden')
340 setting('filament_physical_density', '1240', float, 'preference', 'hidden').setRange(500.0, 3000.0).setLabel('Density (kg/m3)', 'Weight of the filament per m3. Around 1240 for PLA. And around 1040 for ABS. This value is used to estimate the weight if the filament used for the print.')
341 setting('active_machine', '0', int, 'preference', 'hidden')
342
343 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel('Model colour')
344 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
345 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
346 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
347
348 setting('window_maximized', 'True', bool, 'preference', 'hidden')
349 setting('window_pos_x', '-1', float, 'preference', 'hidden')
350 setting('window_pos_y', '-1', float, 'preference', 'hidden')
351 setting('window_width', '-1', float, 'preference', 'hidden')
352 setting('window_height', '-1', float, 'preference', 'hidden')
353 setting('window_normal_sash', '320', float, 'preference', 'hidden')
354
355 setting('machine_name', '', str, 'machine', 'hidden')
356 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
357 setting('machine_width', '205', float, 'machine', 'hidden').setLabel('Maximum width (mm)', 'Size of the machine in mm')
358 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel('Maximum depth (mm)', 'Size of the machine in mm')
359 setting('machine_height', '200', float, 'machine', 'hidden').setLabel('Maximum height (mm)', 'Size of the machine in mm')
360 setting('machine_center_is_zero', 'False', bool, 'machine', 'hidden')
361 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
362 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel('Heated bed', 'If you have an heated bed, this enabled heated bed settings (requires restart)')
363 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode'], 'machine', 'hidden').setLabel('GCode Flavor', 'Flavor of generated GCode.\nRepRap is normal 5D GCode which works on Marlin/Sprinter based firmwares.\nUltiGCode is a variation of the RepRap GCode which puts more settings in the machine instead of the slicer.')
364 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel('Extruder count', 'Amount of extruders in your machine.')
365 setting('extruder_offset_x1', '-21.6', float, 'machine', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
366 setting('extruder_offset_y1', '0.0', float, 'machine', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
367 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel('Offset X', 'The offset of your tertiary extruder compared to the primary.')
368 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel('Offset Y', 'The offset of your tertiary extruder compared to the primary.')
369 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel('Offset X', 'The offset of your forth extruder compared to the primary.')
370 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel('Offset Y', 'The offset of your forth extruder compared to the primary.')
371 setting('steps_per_e', '0', float, 'machine', 'hidden').setLabel('E-Steps per 1mm filament', 'Amount of steps per mm filament extrusion. If set to 0 then this value is ignored and the value in your firmware is used.')
372 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel('Serial port', 'Serial port to use for communication with the printer')
373 setting('serial_port_auto', '', str, 'machine', 'hidden')
374 setting('serial_baud', 'AUTO', str, 'machine', 'hidden').setLabel('Baudrate', 'Speed of the serial port communication\nNeeds to match your firmware settings\nCommon values are 250000, 115200, 57600')
375 setting('serial_baud_auto', '', int, 'machine', 'hidden')
376
377 setting('extruder_head_size_min_x', '0.0', float, 'machine', 'hidden').setLabel('Head size towards X min (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 75mm for an Ultimaker if the fan is on the left side.')
378 setting('extruder_head_size_min_y', '0.0', float, 'machine', 'hidden').setLabel('Head size towards Y min (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 18mm for an Ultimaker if the fan is on the left side.')
379 setting('extruder_head_size_max_x', '0.0', float, 'machine', 'hidden').setLabel('Head size towards X max (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 18mm for an Ultimaker if the fan is on the left side.')
380 setting('extruder_head_size_max_y', '0.0', float, 'machine', 'hidden').setLabel('Head size towards Y max (mm)', 'The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head. 35mm for an Ultimaker if the fan is on the left side.')
381 setting('extruder_head_size_height', '0.0', float, 'machine', 'hidden').setLabel('Printer gantry height (mm)', 'The height of the gantry holding up the printer head. If an object is higher then this then you cannot print multiple objects one for one. 60mm for an Ultimaker.')
382
383 validators.warningAbove(settingsDictionary['filament_flow'], 150, "More flow then 150% is rare and usually not recommended.")
384 validators.warningBelow(settingsDictionary['filament_flow'], 50, "More flow then 50% is rare and usually not recommended.")
385 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.")
386 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
387 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
388 validators.printSpeedValidator(settingsDictionary['print_speed'])
389 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
390 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
391 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
392 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
393 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
394 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
395 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
396 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
397 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
398 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.")
399
400 #Conditions for multiple extruders
401 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
402 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
403 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
404 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
405 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
406 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
407 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
408 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
409 #Heated bed
410 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
411
412 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
413 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
414 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
415 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
416 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
417 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
418 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
419 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
420 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
421 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
422 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
423 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
424 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
425 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
426
427 #########################################################
428 ## Profile and preferences functions
429 #########################################################
430
431 def getSubCategoriesFor(category):
432         done = {}
433         ret = []
434         for s in settingsList:
435                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
436                         done[s.getSubCategory()] = True
437                         ret.append(s.getSubCategory())
438         return ret
439
440 def getSettingsForCategory(category, subCategory = None):
441         ret = []
442         for s in settingsList:
443                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
444                         ret.append(s)
445         return ret
446
447 ## Profile functions
448 def getBasePath():
449         if platform.system() == "Windows":
450                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
451                 #If we have a frozen python install, we need to step out of the library.zip
452                 if hasattr(sys, 'frozen'):
453                         basePath = os.path.normpath(os.path.join(basePath, ".."))
454         else:
455                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
456         if not os.path.isdir(basePath):
457                 os.makedirs(basePath)
458         return basePath
459
460 def getAlternativeBasePaths():
461         paths = []
462         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
463         for subPath in os.listdir(basePath):
464                 path = os.path.join(basePath, subPath)
465                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
466                         paths.append(path)
467                 path = os.path.join(basePath, subPath, 'Cura')
468                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
469                         paths.append(path)
470         return paths
471
472 def getDefaultProfilePath():
473         return os.path.join(getBasePath(), 'current_profile.ini')
474
475 def loadProfile(filename):
476         #Read a configuration file as global config
477         profileParser = ConfigParser.ConfigParser()
478         try:
479                 profileParser.read(filename)
480         except ConfigParser.ParsingError:
481                 return
482         global settingsList
483         for set in settingsList:
484                 if set.isPreference():
485                         continue
486                 section = 'profile'
487                 if set.isAlteration():
488                         section = 'alterations'
489                 if profileParser.has_option(section, set.getName()):
490                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
491
492 def saveProfile(filename):
493         #Save the current profile to an ini file
494         profileParser = ConfigParser.ConfigParser()
495         profileParser.add_section('profile')
496         profileParser.add_section('alterations')
497         global settingsList
498         for set in settingsList:
499                 if set.isPreference() or set.isMachineSetting():
500                         continue
501                 if set.isAlteration():
502                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
503                 else:
504                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
505
506         profileParser.write(open(filename, 'w'))
507
508 def resetProfile():
509         #Read a configuration file as global config
510         global settingsList
511         for set in settingsList:
512                 if set.isPreference():
513                         continue
514                 set.setValue(set.getDefault())
515
516         if getMachineSetting('machine_type') == 'ultimaker':
517                 putProfileSetting('nozzle_size', '0.4')
518                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
519                         putProfileSetting('retraction_enable', 'True')
520         elif getMachineSetting('machine_type') == 'ultimaker2':
521                 putProfileSetting('nozzle_size', '0.4')
522                 putProfileSetting('retraction_enable', 'True')
523         else:
524                 putProfileSetting('nozzle_size', '0.5')
525
526 def setProfileFromString(options):
527         options = base64.b64decode(options)
528         options = zlib.decompress(options)
529         (profileOpts, alt) = options.split('\f', 1)
530         global settingsDictionary
531         for option in profileOpts.split('\b'):
532                 if len(option) > 0:
533                         (key, value) = option.split('=', 1)
534                         if key in settingsDictionary:
535                                 if settingsDictionary[key].isProfile():
536                                         settingsDictionary[key].setValue(value)
537         for option in alt.split('\b'):
538                 if len(option) > 0:
539                         (key, value) = option.split('=', 1)
540                         if key in settingsDictionary:
541                                 if settingsDictionary[key].isAlteration():
542                                         settingsDictionary[key].setValue(value)
543
544 def getProfileString():
545         p = []
546         alt = []
547         global settingsList
548         for set in settingsList:
549                 if set.isProfile():
550                         if set.getName() in tempOverride:
551                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
552                         else:
553                                 p.append(set.getName() + "=" + set.getValue())
554                 elif set.isAlteration():
555                         if set.getName() in tempOverride:
556                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
557                         else:
558                                 alt.append(set.getName() + "=" + set.getValue())
559         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
560         ret = base64.b64encode(zlib.compress(ret, 9))
561         return ret
562
563 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
564         lines = []
565         for i in xrange(0, len(string), every):
566                 lines.append(string[i:i+every])
567         return '\n'.join(lines)
568
569 def getPreferencesString():
570         p = []
571         global settingsList
572         for set in settingsList:
573                 if set.isPreference():
574                         p.append(set.getName() + "=" + set.getValue())
575         ret = '\b'.join(p)
576         ret = base64.b64encode(zlib.compress(ret, 9))
577         return ret
578
579
580 def getProfileSetting(name):
581         if name in tempOverride:
582                 return tempOverride[name]
583         global settingsDictionary
584         if name in settingsDictionary and settingsDictionary[name].isProfile():
585                 return settingsDictionary[name].getValue()
586         traceback.print_stack()
587         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
588         return ''
589
590 def getProfileSettingFloat(name):
591         try:
592                 setting = getProfileSetting(name).replace(',', '.')
593                 return float(eval(setting, {}, {}))
594         except:
595                 return 0.0
596
597 def putProfileSetting(name, value):
598         #Check if we have a configuration file loaded, else load the default.
599         global settingsDictionary
600         if name in settingsDictionary and settingsDictionary[name].isProfile():
601                 settingsDictionary[name].setValue(value)
602
603 def isProfileSetting(name):
604         global settingsDictionary
605         if name in settingsDictionary and settingsDictionary[name].isProfile():
606                 return True
607         return False
608
609 ## Preferences functions
610 def getPreferencePath():
611         return os.path.join(getBasePath(), 'preferences.ini')
612
613 def getPreferenceFloat(name):
614         try:
615                 setting = getPreference(name).replace(',', '.')
616                 return float(eval(setting, {}, {}))
617         except:
618                 return 0.0
619
620 def getPreferenceColour(name):
621         colorString = getPreference(name)
622         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
623
624 def loadPreferences(filename):
625         global settingsList
626         #Read a configuration file as global config
627         profileParser = ConfigParser.ConfigParser()
628         try:
629                 profileParser.read(filename)
630         except ConfigParser.ParsingError:
631                 return
632
633         for set in settingsList:
634                 if set.isPreference():
635                         if profileParser.has_option('preference', set.getName()):
636                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
637
638         n = 0
639         while profileParser.has_section('machine_%d' % (n)):
640                 for set in settingsList:
641                         if set.isMachineSetting():
642                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
643                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
644                 n += 1
645
646         setActiveMachine(int(getPreferenceFloat('active_machine')))
647
648 def savePreferences(filename):
649         global settingsList
650         #Save the current profile to an ini file
651         parser = ConfigParser.ConfigParser()
652         parser.add_section('preference')
653
654         for set in settingsList:
655                 if set.isPreference():
656                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
657
658         n = 0
659         while getMachineSetting('machine_name', n) != '':
660                 parser.add_section('machine_%d' % (n))
661                 for set in settingsList:
662                         if set.isMachineSetting():
663                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
664                 n += 1
665         parser.write(open(filename, 'w'))
666
667 def getPreference(name):
668         if name in tempOverride:
669                 return tempOverride[name]
670         global settingsDictionary
671         if name in settingsDictionary and settingsDictionary[name].isPreference():
672                 return settingsDictionary[name].getValue()
673         traceback.print_stack()
674         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
675         return ''
676
677 def putPreference(name, value):
678         #Check if we have a configuration file loaded, else load the default.
679         global settingsDictionary
680         if name in settingsDictionary and settingsDictionary[name].isPreference():
681                 settingsDictionary[name].setValue(value)
682                 savePreferences(getPreferencePath())
683                 return
684         traceback.print_stack()
685         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
686
687 def isPreference(name):
688         global settingsDictionary
689         if name in settingsDictionary and settingsDictionary[name].isPreference():
690                 return True
691         return False
692
693 def getMachineSettingFloat(name):
694         try:
695                 setting = getMachineSetting(name).replace(',', '.')
696                 return float(eval(setting, {}, {}))
697         except:
698                 return 0.0
699
700 def getMachineSetting(name, index = None):
701         if name in tempOverride:
702                 return tempOverride[name]
703         global settingsDictionary
704         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
705                 return settingsDictionary[name].getValue(index)
706         traceback.print_stack()
707         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
708         return ''
709
710 def putMachineSetting(name, value):
711         #Check if we have a configuration file loaded, else load the default.
712         global settingsDictionary
713         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
714                 settingsDictionary[name].setValue(value)
715         savePreferences(getPreferencePath())
716
717 def isMachineSetting(name):
718         global settingsDictionary
719         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
720                 return True
721         return False
722
723 def checkAndUpdateMachineName():
724         global _selectedMachineIndex
725         name = getMachineSetting('machine_name')
726         index = None
727         if name == '':
728                 name = getMachineSetting('machine_type')
729         for n in xrange(0, getMachineCount()):
730                 if n == _selectedMachineIndex:
731                         continue
732                 if index is None:
733                         if name == getMachineSetting('machine_name', n):
734                                 index = 1
735                 else:
736                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
737                                 index += 1
738         if index is not None:
739                 name = '%s (%d)' % (name, index)
740         putMachineSetting('machine_name', name)
741         putPreference('active_machine', _selectedMachineIndex)
742
743 def getMachineCount():
744         n = 0
745         while getMachineSetting('machine_name', n) != '':
746                 n += 1
747         if n < 1:
748                 return 1
749         return n
750
751 def setActiveMachine(index):
752         global _selectedMachineIndex
753         _selectedMachineIndex = index
754         putPreference('active_machine', _selectedMachineIndex)
755
756 def removeMachine(index):
757         global _selectedMachineIndex
758         global settingsList
759         if getMachineCount() < 2:
760                 return
761         for n in xrange(index, getMachineCount()):
762                 for setting in settingsList:
763                         if setting.isMachineSetting():
764                                 setting.setValue(setting.getValue(n+1), n)
765
766         if _selectedMachineIndex >= index:
767                 setActiveMachine(getMachineCount() - 1)
768
769 ## Temp overrides for multi-extruder slicing and the project planner.
770 tempOverride = {}
771 def setTempOverride(name, value):
772         tempOverride[name] = unicode(value).encode("utf-8")
773 def clearTempOverride(name):
774         del tempOverride[name]
775 def resetTempOverride():
776         tempOverride.clear()
777
778 #########################################################
779 ## Utility functions to calculate common profile values
780 #########################################################
781 def calculateEdgeWidth():
782         wallThickness = getProfileSettingFloat('wall_thickness')
783         nozzleSize = getProfileSettingFloat('nozzle_size')
784
785         if wallThickness < 0.01:
786                 return nozzleSize
787         if wallThickness < nozzleSize:
788                 return wallThickness
789
790         lineCount = int(wallThickness / (nozzleSize - 0.0001))
791         if lineCount == 0:
792                 return nozzleSize
793         lineWidth = wallThickness / lineCount
794         lineWidthAlt = wallThickness / (lineCount + 1)
795         if lineWidth > nozzleSize * 1.5:
796                 return lineWidthAlt
797         return lineWidth
798
799 def calculateLineCount():
800         wallThickness = getProfileSettingFloat('wall_thickness')
801         nozzleSize = getProfileSettingFloat('nozzle_size')
802
803         if wallThickness < 0.01:
804                 return 0
805         if wallThickness < nozzleSize:
806                 return 1
807
808         lineCount = int(wallThickness / (nozzleSize - 0.0001))
809         if lineCount < 1:
810                 lineCount = 1
811         lineWidth = wallThickness / lineCount
812         lineWidthAlt = wallThickness / (lineCount + 1)
813         if lineWidth > nozzleSize * 1.5:
814                 return lineCount + 1
815         return lineCount
816
817 def calculateSolidLayerCount():
818         layerHeight = getProfileSettingFloat('layer_height')
819         solidThickness = getProfileSettingFloat('solid_layer_thickness')
820         if layerHeight == 0.0:
821                 return 1
822         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
823
824 def calculateObjectSizeOffsets():
825         size = 0.0
826
827         if getProfileSetting('platform_adhesion') == 'Brim':
828                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
829         elif getProfileSetting('platform_adhesion') == 'Raft':
830                 pass
831         else:
832                 if getProfileSettingFloat('skirt_line_count') > 0:
833                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
834
835         #if getProfileSetting('enable_raft') != 'False':
836         #       size += profile.getProfileSettingFloat('raft_margin') * 2
837         #if getProfileSetting('support') != 'None':
838         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
839         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
840         return [size, size]
841
842 def getMachineCenterCoords():
843         if getMachineSetting('machine_center_is_zero') == 'True':
844                 return [0, 0]
845         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
846
847 #########################################################
848 ## Alteration file functions
849 #########################################################
850 def replaceTagMatch(m):
851         pre = m.group(1)
852         tag = m.group(2)
853         if tag == 'time':
854                 return pre + time.strftime('%H:%M:%S')
855         if tag == 'date':
856                 return pre + time.strftime('%d-%m-%Y')
857         if tag == 'day':
858                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
859         if tag == 'print_time':
860                 return pre + '#P_TIME#'
861         if tag == 'filament_amount':
862                 return pre + '#F_AMNT#'
863         if tag == 'filament_weight':
864                 return pre + '#F_WGHT#'
865         if tag == 'filament_cost':
866                 return pre + '#F_COST#'
867         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
868                 f = getProfileSettingFloat(tag) * 60
869         elif isProfileSetting(tag):
870                 f = getProfileSettingFloat(tag)
871         elif isPreference(tag):
872                 f = getProfileSettingFloat(tag)
873         else:
874                 return '%s?%s?' % (pre, tag)
875         if (f % 1) == 0:
876                 return pre + str(int(f))
877         return pre + str(f)
878
879 def replaceGCodeTags(filename, gcodeInt):
880         f = open(filename, 'r+')
881         data = f.read(2048)
882         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
883         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
884         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
885         cost = gcodeInt.calculateCost()
886         if cost is None:
887                 cost = 'Unknown'
888         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
889         f.seek(0)
890         f.write(data)
891         f.close()
892
893 ### Get aleration raw contents. (Used internally in Cura)
894 def getAlterationFile(filename):
895         if filename in tempOverride:
896                 return tempOverride[filename]
897         global settingsDictionary
898         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
899                 return settingsDictionary[filename].getValue()
900         traceback.print_stack()
901         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
902         return ''
903
904 def setAlterationFile(name, value):
905         #Check if we have a configuration file loaded, else load the default.
906         global settingsDictionary
907         if name in settingsDictionary and settingsDictionary[name].isAlteration():
908                 settingsDictionary[name].setValue(value)
909         saveProfile(getDefaultProfilePath())
910
911 ### Get the alteration file for output. (Used by Skeinforge)
912 def getAlterationFileContents(filename, extruderCount = 1):
913         prefix = ''
914         postfix = ''
915         alterationContents = getAlterationFile(filename)
916         if getMachineSetting('gcode_flavor') == 'UltiGCode':
917                 return ''
918         if filename == 'start.gcode':
919                 if extruderCount > 1:
920                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
921                 #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.
922                 #We also set our steps per E here, if configured.
923                 eSteps = getMachineSettingFloat('steps_per_e')
924                 if eSteps > 0:
925                         prefix += 'M92 E%f\n' % (eSteps)
926                 temp = getProfileSettingFloat('print_temperature')
927                 bedTemp = 0
928                 if getMachineSetting('has_heated_bed') == 'True':
929                         bedTemp = getProfileSettingFloat('print_bed_temperature')
930
931                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
932                         prefix += 'M140 S%f\n' % (bedTemp)
933                 if temp > 0 and not '{print_temperature}' in alterationContents:
934                         if extruderCount > 0:
935                                 for n in xrange(1, extruderCount):
936                                         t = temp
937                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
938                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
939                                         prefix += 'M104 T%d S%f\n' % (n, t)
940                                 for n in xrange(0, extruderCount):
941                                         t = temp
942                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
943                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
944                                         prefix += 'M109 T%d S%f\n' % (n, t)
945                                 prefix += 'T0\n'
946                         else:
947                                 prefix += 'M109 S%f\n' % (temp)
948                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
949                         prefix += 'M190 S%f\n' % (bedTemp)
950         elif filename == 'end.gcode':
951                 if extruderCount > 1:
952                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
953                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
954                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
955         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
956
957 ###### PLUGIN #####
958
959 def getPluginConfig():
960         try:
961                 return pickle.loads(str(getProfileSetting('plugin_config')))
962         except:
963                 return []
964
965 def setPluginConfig(config):
966         putProfileSetting('plugin_config', pickle.dumps(config))
967
968 def getPluginBasePaths():
969         ret = []
970         if platform.system() != "Windows":
971                 ret.append(os.path.expanduser('~/.cura/plugins/'))
972         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
973                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
974         else:
975                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
976         return ret
977
978 def getPluginList():
979         ret = []
980         for basePath in getPluginBasePaths():
981                 for filename in glob.glob(os.path.join(basePath, '*.py')):
982                         filename = os.path.basename(filename)
983                         if filename.startswith('_'):
984                                 continue
985                         with open(os.path.join(basePath, filename), "r") as f:
986                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
987                                 for line in f:
988                                         line = line.strip()
989                                         if not line.startswith('#'):
990                                                 break
991                                         line = line[1:].split(':', 1)
992                                         if len(line) != 2:
993                                                 continue
994                                         if line[0].upper() == 'NAME':
995                                                 item['name'] = line[1].strip()
996                                         elif line[0].upper() == 'INFO':
997                                                 item['info'] = line[1].strip()
998                                         elif line[0].upper() == 'TYPE':
999                                                 item['type'] = line[1].strip()
1000                                         elif line[0].upper() == 'DEPEND':
1001                                                 pass
1002                                         elif line[0].upper() == 'PARAM':
1003                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
1004                                                 if m is not None:
1005                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
1006                                         else:
1007                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
1008                                 if item['name'] is not None and item['type'] == 'postprocess':
1009                                         ret.append(item)
1010         return ret
1011
1012 def runPostProcessingPlugins(gcodefilename):
1013         pluginConfigList = getPluginConfig()
1014         pluginList = getPluginList()
1015
1016         for pluginConfig in pluginConfigList:
1017                 plugin = None
1018                 for pluginTest in pluginList:
1019                         if pluginTest['filename'] == pluginConfig['filename']:
1020                                 plugin = pluginTest
1021                 if plugin is None:
1022                         continue
1023
1024                 pythonFile = None
1025                 for basePath in getPluginBasePaths():
1026                         testFilename = os.path.join(basePath, pluginConfig['filename'])
1027                         if os.path.isfile(testFilename):
1028                                 pythonFile = testFilename
1029                 if pythonFile is None:
1030                         continue
1031
1032                 locals = {'filename': gcodefilename}
1033                 for param in plugin['params']:
1034                         value = param['default']
1035                         if param['name'] in pluginConfig['params']:
1036                                 value = pluginConfig['params'][param['name']]
1037
1038                         if param['type'] == 'float':
1039                                 try:
1040                                         value = float(value)
1041                                 except:
1042                                         value = float(param['default'])
1043
1044                         locals[param['name']] = value
1045                 try:
1046                         execfile(pythonFile, locals)
1047                 except:
1048                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
1049                         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])
1050         return None