chiark / gitweb /
by default, set extruder to absolute mode
[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
149 #Define a fake _() function to fake the gettext tools in to generating strings for the profile settings.
150 def _(n):
151         return n
152
153 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."))
154 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."))
155 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."))
156 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."))
157 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 affect the outside of the print and only adjusts how strong the part becomes."))
158 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."))
159 setting('print_speed',                50, float, 'basic',    _('Speed and 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."))
160 setting('print_temperature',         220, int,   'basic',    _('Speed and 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."))
161 setting('print_temperature2',          0, int,   'basic',    _('Speed and 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."))
162 setting('print_temperature3',          0, int,   'basic',    _('Speed and 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."))
163 setting('print_temperature4',          0, int,   'basic',    _('Speed and 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."))
164 setting('print_bed_temperature',      70, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("Bed temperature (C)"), _("Temperature used for the heated printer bed. Set at 0 to pre-heat yourself."))
165 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."))
166 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)"))
167 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."))
168 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."))
169 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."))
170 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."))
171 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."))
172 setting('filament_flow',            100., float, 'basic',    _('Filament')).setRange(1,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
173 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."))
174 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."))
175 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."))
176 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."))
177 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."))
178 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."))
179 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."))
180 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."))
181 #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."))
182 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."))
183 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."))
184 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."))
185 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.."))
186 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."))
187 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."))
188
189 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."))
190 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."))
191 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."))
192 #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."))
193 #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.'))
194 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."))
195 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."))
196 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%."))
197 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."))
198 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."))
199 #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."))
200 #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')
201 #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\''))
202 #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."))
203 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."))
204 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."))
205 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."))
206 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."))
207 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."))
208 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."))
209 #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."))
210 #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."))
211 #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."))
212 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."))
213 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."))
214 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."))
215 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."))
216 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."))
217 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."))
218 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."))
219 #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)."))
220 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."))
221 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."))
222 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."))
223 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."))
224
225 setting('plugin_config', '', str, 'hidden', 'hidden')
226 setting('object_center_x', -1, float, 'hidden', 'hidden')
227 setting('object_center_y', -1, float, 'hidden', 'hidden')
228
229 setting('start.gcode', """;Sliced at: {day} {date} {time}
230 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
231 ;Print time: {print_time}
232 ;Filament used: {filament_amount}m {filament_weight}g
233 ;Filament cost: {filament_cost}
234 G21        ;metric values
235 G90        ;absolute positioning
236 M82        ;set extruder to absolute mode
237 M107       ;start with the fan off
238
239 G28 X0 Y0  ;move X/Y to min endstops
240 G28 Z0     ;move Z to min endstops
241
242 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
243
244 G92 E0                  ;zero the extruded length
245 G1 F200 E3              ;extrude 3mm of feed stock
246 G92 E0                  ;zero the extruded length again
247 G1 F{travel_speed}
248 M117 Printing...
249 """, str, 'alteration', 'alteration')
250 #######################################################################################
251 setting('end.gcode', """;End GCode
252 M104 S0                     ;extruder heater off
253 M140 S0                     ;heated bed heater off (if you have it)
254
255 G91                                    ;relative positioning
256 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
257 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
258 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
259
260 M84                         ;steppers off
261 G90                         ;absolute positioning
262 """, str, 'alteration', 'alteration')
263 #######################################################################################
264 setting('start2.gcode', """;Sliced at: {day} {date} {time}
265 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
266 ;Print time: {print_time}
267 ;Filament used: {filament_amount}m {filament_weight}g
268 ;Filament cost: {filament_cost}
269 G21        ;metric values
270 G90        ;absolute positioning
271 M107       ;start with the fan off
272
273 G28 X0 Y0  ;move X/Y to min endstops
274 G28 Z0     ;move Z to min endstops
275
276 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
277
278 T1
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 F200 E-{retraction_dual_amount}
283
284 T0
285 G92 E0                  ;zero the extruded length
286 G1 F200 E10              ;extrude 10mm of feed stock
287 G92 E0                  ;zero the extruded length again
288 G1 F{travel_speed}
289 M117 Printing...
290 """, str, 'alteration', 'alteration')
291 #######################################################################################
292 setting('end2.gcode', """;End GCode
293 M104 T0 S0                     ;extruder heater off
294 M104 T1 S0                     ;extruder heater off
295 M140 S0                     ;heated bed heater off (if you have it)
296
297 G91                                    ;relative positioning
298 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
299 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
300 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
301
302 M84                         ;steppers off
303 G90                         ;absolute positioning
304 """, str, 'alteration', 'alteration')
305 #######################################################################################
306 setting('support_start.gcode', '', str, 'alteration', 'alteration')
307 setting('support_end.gcode', '', str, 'alteration', 'alteration')
308 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
309 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
310 setting('replace.csv', '', str, 'alteration', 'alteration')
311 #######################################################################################
312 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
313 G92 E0
314 G1 E-36 F5000
315 G92 E0
316 T{extruder}
317 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
318 G1 E36 F5000
319 G92 E0
320 """, str, 'alteration', 'alteration')
321
322 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
323 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
324 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."))
325 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."))
326 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."))
327 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."))
328 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
329 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve next versions of Cura"))
330 setting('youmagine_token', '', str, 'preference', 'hidden')
331 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."))
332 setting('language', 'English', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
333 setting('active_machine', '0', int, 'preference', 'hidden')
334
335 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel(_('Model colour'))
336 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'))
337 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'))
338 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'))
339
340 setting('window_maximized', 'True', bool, 'preference', 'hidden')
341 setting('window_pos_x', '-1', float, 'preference', 'hidden')
342 setting('window_pos_y', '-1', float, 'preference', 'hidden')
343 setting('window_width', '-1', float, 'preference', 'hidden')
344 setting('window_height', '-1', float, 'preference', 'hidden')
345 setting('window_normal_sash', '320', float, 'preference', 'hidden')
346
347 setting('machine_name', '', str, 'machine', 'hidden')
348 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
349 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Size of the machine in mm"))
350 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
351 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine in mm"))
352 setting('machine_center_is_zero', 'False', bool, 'machine', 'hidden').setLabel(_("Machine center 0,0"), _("Machines firmware defines the center of the bed as 0,0 instead of the front left corner."))
353 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
354 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have an heated bed, this enabled heated bed settings (requires restart)"))
355 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode', 'MakerBot'], '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.\nMakerBot GCode has a few changes in the way GCode is generated, but still requires MakerWare to generate to X3G."))
356 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
357 setting('extruder_offset_x1', '-21.6', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
358 setting('extruder_offset_y1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
359 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
360 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
361 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
362 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
363 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."))
364 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
365 setting('serial_port_auto', '', str, 'machine', 'hidden')
366 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"))
367 setting('serial_baud_auto', '', int, 'machine', 'hidden')
368
369 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."))
370 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."))
371 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."))
372 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."))
373 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."))
374
375 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
376 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
377 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."))
378 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
379 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
380 validators.printSpeedValidator(settingsDictionary['print_speed'])
381 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
382 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
383 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
384 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
385 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
386 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
387 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
388 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
389 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
390 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."))
391
392 #Conditions for multiple extruders
393 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
394 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
395 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
396 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
397 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
398 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
399 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
400 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
401 #Heated bed
402 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
403
404 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
405 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
406 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
407 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
408 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
409 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
410 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
411 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
412 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
413 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
414 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
415 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
416 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
417 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
418
419 #Remove fake defined _() because later the localization will define a global _()
420 del _
421
422 #########################################################
423 ## Profile and preferences functions
424 #########################################################
425
426 def getSubCategoriesFor(category):
427         done = {}
428         ret = []
429         for s in settingsList:
430                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
431                         done[s.getSubCategory()] = True
432                         ret.append(s.getSubCategory())
433         return ret
434
435 def getSettingsForCategory(category, subCategory = None):
436         ret = []
437         for s in settingsList:
438                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
439                         ret.append(s)
440         return ret
441
442 ## Profile functions
443 def getBasePath():
444         if platform.system() == "Windows":
445                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
446                 #If we have a frozen python install, we need to step out of the library.zip
447                 if hasattr(sys, 'frozen'):
448                         basePath = os.path.normpath(os.path.join(basePath, ".."))
449         else:
450                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
451         if not os.path.isdir(basePath):
452                 os.makedirs(basePath)
453         return basePath
454
455 def getAlternativeBasePaths():
456         paths = []
457         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
458         for subPath in os.listdir(basePath):
459                 path = os.path.join(basePath, subPath)
460                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
461                         paths.append(path)
462                 path = os.path.join(basePath, subPath, 'Cura')
463                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
464                         paths.append(path)
465         return paths
466
467 def getDefaultProfilePath():
468         return os.path.join(getBasePath(), 'current_profile.ini')
469
470 def loadProfile(filename):
471         #Read a configuration file as global config
472         profileParser = ConfigParser.ConfigParser()
473         try:
474                 profileParser.read(filename)
475         except ConfigParser.ParsingError:
476                 return
477         global settingsList
478         for set in settingsList:
479                 if set.isPreference():
480                         continue
481                 section = 'profile'
482                 if set.isAlteration():
483                         section = 'alterations'
484                 if profileParser.has_option(section, set.getName()):
485                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
486
487 def saveProfile(filename):
488         #Save the current profile to an ini file
489         profileParser = ConfigParser.ConfigParser()
490         profileParser.add_section('profile')
491         profileParser.add_section('alterations')
492         global settingsList
493         for set in settingsList:
494                 if set.isPreference() or set.isMachineSetting():
495                         continue
496                 if set.isAlteration():
497                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
498                 else:
499                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
500
501         profileParser.write(open(filename, 'w'))
502
503 def resetProfile():
504         #Read a configuration file as global config
505         global settingsList
506         for set in settingsList:
507                 if set.isPreference():
508                         continue
509                 set.setValue(set.getDefault())
510
511         if getMachineSetting('machine_type') == 'ultimaker':
512                 putProfileSetting('nozzle_size', '0.4')
513                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
514                         putProfileSetting('retraction_enable', 'True')
515         elif getMachineSetting('machine_type') == 'ultimaker2':
516                 putProfileSetting('nozzle_size', '0.4')
517                 putProfileSetting('retraction_enable', 'True')
518         else:
519                 putProfileSetting('nozzle_size', '0.5')
520
521 def setProfileFromString(options):
522         options = base64.b64decode(options)
523         options = zlib.decompress(options)
524         (profileOpts, alt) = options.split('\f', 1)
525         global settingsDictionary
526         for option in profileOpts.split('\b'):
527                 if len(option) > 0:
528                         (key, value) = option.split('=', 1)
529                         if key in settingsDictionary:
530                                 if settingsDictionary[key].isProfile():
531                                         settingsDictionary[key].setValue(value)
532         for option in alt.split('\b'):
533                 if len(option) > 0:
534                         (key, value) = option.split('=', 1)
535                         if key in settingsDictionary:
536                                 if settingsDictionary[key].isAlteration():
537                                         settingsDictionary[key].setValue(value)
538
539 def getProfileString():
540         p = []
541         alt = []
542         global settingsList
543         for set in settingsList:
544                 if set.isProfile():
545                         if set.getName() in tempOverride:
546                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
547                         else:
548                                 p.append(set.getName() + "=" + set.getValue())
549                 elif set.isAlteration():
550                         if set.getName() in tempOverride:
551                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
552                         else:
553                                 alt.append(set.getName() + "=" + set.getValue())
554         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
555         ret = base64.b64encode(zlib.compress(ret, 9))
556         return ret
557
558 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
559         lines = []
560         for i in xrange(0, len(string), every):
561                 lines.append(string[i:i+every])
562         return '\n'.join(lines)
563
564 def getPreferencesString():
565         p = []
566         global settingsList
567         for set in settingsList:
568                 if set.isPreference():
569                         p.append(set.getName() + "=" + set.getValue())
570         ret = '\b'.join(p)
571         ret = base64.b64encode(zlib.compress(ret, 9))
572         return ret
573
574
575 def getProfileSetting(name):
576         if name in tempOverride:
577                 return tempOverride[name]
578         global settingsDictionary
579         if name in settingsDictionary and settingsDictionary[name].isProfile():
580                 return settingsDictionary[name].getValue()
581         traceback.print_stack()
582         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
583         return ''
584
585 def getProfileSettingFloat(name):
586         try:
587                 setting = getProfileSetting(name).replace(',', '.')
588                 return float(eval(setting, {}, {}))
589         except:
590                 return 0.0
591
592 def putProfileSetting(name, value):
593         #Check if we have a configuration file loaded, else load the default.
594         global settingsDictionary
595         if name in settingsDictionary and settingsDictionary[name].isProfile():
596                 settingsDictionary[name].setValue(value)
597
598 def isProfileSetting(name):
599         global settingsDictionary
600         if name in settingsDictionary and settingsDictionary[name].isProfile():
601                 return True
602         return False
603
604 ## Preferences functions
605 def getPreferencePath():
606         return os.path.join(getBasePath(), 'preferences.ini')
607
608 def getPreferenceFloat(name):
609         try:
610                 setting = getPreference(name).replace(',', '.')
611                 return float(eval(setting, {}, {}))
612         except:
613                 return 0.0
614
615 def getPreferenceColour(name):
616         colorString = getPreference(name)
617         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
618
619 def loadPreferences(filename):
620         global settingsList
621         #Read a configuration file as global config
622         profileParser = ConfigParser.ConfigParser()
623         try:
624                 profileParser.read(filename)
625         except ConfigParser.ParsingError:
626                 return
627
628         for set in settingsList:
629                 if set.isPreference():
630                         if profileParser.has_option('preference', set.getName()):
631                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
632
633         n = 0
634         while profileParser.has_section('machine_%d' % (n)):
635                 for set in settingsList:
636                         if set.isMachineSetting():
637                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
638                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
639                 n += 1
640
641         setActiveMachine(int(getPreferenceFloat('active_machine')))
642
643 def loadMachineSettings(filename):
644         global settingsList
645         #Read a configuration file as global config
646         profileParser = ConfigParser.ConfigParser()
647         try:
648                 profileParser.read(filename)
649         except ConfigParser.ParsingError:
650                 return
651
652         for set in settingsList:
653                 if set.isMachineSetting():
654                         if profileParser.has_option('machine', set.getName()):
655                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
656         checkAndUpdateMachineName()
657
658 def savePreferences(filename):
659         global settingsList
660         #Save the current profile to an ini file
661         parser = ConfigParser.ConfigParser()
662         parser.add_section('preference')
663
664         for set in settingsList:
665                 if set.isPreference():
666                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
667
668         n = 0
669         while getMachineSetting('machine_name', n) != '':
670                 parser.add_section('machine_%d' % (n))
671                 for set in settingsList:
672                         if set.isMachineSetting():
673                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
674                 n += 1
675         parser.write(open(filename, 'w'))
676
677 def getPreference(name):
678         if name in tempOverride:
679                 return tempOverride[name]
680         global settingsDictionary
681         if name in settingsDictionary and settingsDictionary[name].isPreference():
682                 return settingsDictionary[name].getValue()
683         traceback.print_stack()
684         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
685         return ''
686
687 def putPreference(name, value):
688         #Check if we have a configuration file loaded, else load the default.
689         global settingsDictionary
690         if name in settingsDictionary and settingsDictionary[name].isPreference():
691                 settingsDictionary[name].setValue(value)
692                 savePreferences(getPreferencePath())
693                 return
694         traceback.print_stack()
695         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
696
697 def isPreference(name):
698         global settingsDictionary
699         if name in settingsDictionary and settingsDictionary[name].isPreference():
700                 return True
701         return False
702
703 def getMachineSettingFloat(name):
704         try:
705                 setting = getMachineSetting(name).replace(',', '.')
706                 return float(eval(setting, {}, {}))
707         except:
708                 return 0.0
709
710 def getMachineSetting(name, index = None):
711         if name in tempOverride:
712                 return tempOverride[name]
713         global settingsDictionary
714         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
715                 return settingsDictionary[name].getValue(index)
716         traceback.print_stack()
717         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
718         return ''
719
720 def putMachineSetting(name, value):
721         #Check if we have a configuration file loaded, else load the default.
722         global settingsDictionary
723         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
724                 settingsDictionary[name].setValue(value)
725         savePreferences(getPreferencePath())
726
727 def isMachineSetting(name):
728         global settingsDictionary
729         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
730                 return True
731         return False
732
733 def checkAndUpdateMachineName():
734         global _selectedMachineIndex
735         name = getMachineSetting('machine_name')
736         index = None
737         if name == '':
738                 name = getMachineSetting('machine_type')
739         for n in xrange(0, getMachineCount()):
740                 if n == _selectedMachineIndex:
741                         continue
742                 if index is None:
743                         if name == getMachineSetting('machine_name', n):
744                                 index = 1
745                 else:
746                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
747                                 index += 1
748         if index is not None:
749                 name = '%s (%d)' % (name, index)
750         putMachineSetting('machine_name', name)
751         putPreference('active_machine', _selectedMachineIndex)
752
753 def getMachineCount():
754         n = 0
755         while getMachineSetting('machine_name', n) != '':
756                 n += 1
757         if n < 1:
758                 return 1
759         return n
760
761 def setActiveMachine(index):
762         global _selectedMachineIndex
763         _selectedMachineIndex = index
764         putPreference('active_machine', _selectedMachineIndex)
765
766 def removeMachine(index):
767         global _selectedMachineIndex
768         global settingsList
769         if getMachineCount() < 2:
770                 return
771         for n in xrange(index, getMachineCount()):
772                 for setting in settingsList:
773                         if setting.isMachineSetting():
774                                 setting.setValue(setting.getValue(n+1), n)
775
776         if _selectedMachineIndex >= index:
777                 setActiveMachine(getMachineCount() - 1)
778
779 ## Temp overrides for multi-extruder slicing and the project planner.
780 tempOverride = {}
781 def setTempOverride(name, value):
782         tempOverride[name] = unicode(value).encode("utf-8")
783 def clearTempOverride(name):
784         del tempOverride[name]
785 def resetTempOverride():
786         tempOverride.clear()
787
788 #########################################################
789 ## Utility functions to calculate common profile values
790 #########################################################
791 def calculateEdgeWidth():
792         wallThickness = getProfileSettingFloat('wall_thickness')
793         nozzleSize = getProfileSettingFloat('nozzle_size')
794
795         if wallThickness < 0.01:
796                 return nozzleSize
797         if wallThickness < nozzleSize:
798                 return wallThickness
799
800         lineCount = int(wallThickness / (nozzleSize - 0.0001))
801         if lineCount == 0:
802                 return nozzleSize
803         lineWidth = wallThickness / lineCount
804         lineWidthAlt = wallThickness / (lineCount + 1)
805         if lineWidth > nozzleSize * 1.5:
806                 return lineWidthAlt
807         return lineWidth
808
809 def calculateLineCount():
810         wallThickness = getProfileSettingFloat('wall_thickness')
811         nozzleSize = getProfileSettingFloat('nozzle_size')
812
813         if wallThickness < 0.01:
814                 return 0
815         if wallThickness < nozzleSize:
816                 return 1
817
818         lineCount = int(wallThickness / (nozzleSize - 0.0001))
819         if lineCount < 1:
820                 lineCount = 1
821         lineWidth = wallThickness / lineCount
822         lineWidthAlt = wallThickness / (lineCount + 1)
823         if lineWidth > nozzleSize * 1.5:
824                 return lineCount + 1
825         return lineCount
826
827 def calculateSolidLayerCount():
828         layerHeight = getProfileSettingFloat('layer_height')
829         solidThickness = getProfileSettingFloat('solid_layer_thickness')
830         if layerHeight == 0.0:
831                 return 1
832         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
833
834 def calculateObjectSizeOffsets():
835         size = 0.0
836
837         if getProfileSetting('platform_adhesion') == 'Brim':
838                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
839         elif getProfileSetting('platform_adhesion') == 'Raft':
840                 pass
841         else:
842                 if getProfileSettingFloat('skirt_line_count') > 0:
843                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
844
845         #if getProfileSetting('enable_raft') != 'False':
846         #       size += profile.getProfileSettingFloat('raft_margin') * 2
847         #if getProfileSetting('support') != 'None':
848         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
849         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
850         return [size, size]
851
852 def getMachineCenterCoords():
853         if getMachineSetting('machine_center_is_zero') == 'True':
854                 return [0, 0]
855         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
856
857 #########################################################
858 ## Alteration file functions
859 #########################################################
860 def replaceTagMatch(m):
861         pre = m.group(1)
862         tag = m.group(2)
863         if tag == 'time':
864                 return pre + time.strftime('%H:%M:%S')
865         if tag == 'date':
866                 return pre + time.strftime('%d-%m-%Y')
867         if tag == 'day':
868                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
869         if tag == 'print_time':
870                 return pre + '#P_TIME#'
871         if tag == 'filament_amount':
872                 return pre + '#F_AMNT#'
873         if tag == 'filament_weight':
874                 return pre + '#F_WGHT#'
875         if tag == 'filament_cost':
876                 return pre + '#F_COST#'
877         if pre == 'F' and tag == 'max_z_speed':
878                 f = getProfileSettingFloat('travel_speed') * 60
879         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
880                 f = getProfileSettingFloat(tag) * 60
881         elif isProfileSetting(tag):
882                 f = getProfileSettingFloat(tag)
883         elif isPreference(tag):
884                 f = getProfileSettingFloat(tag)
885         else:
886                 return '%s?%s?' % (pre, tag)
887         if (f % 1) == 0:
888                 return pre + str(int(f))
889         return pre + str(f)
890
891 def replaceGCodeTags(filename, gcodeInt):
892         f = open(filename, 'r+')
893         data = f.read(2048)
894         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
895         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
896         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
897         cost = gcodeInt.calculateCost()
898         if cost is None:
899                 cost = 'Unknown'
900         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
901         f.seek(0)
902         f.write(data)
903         f.close()
904
905 ### Get aleration raw contents. (Used internally in Cura)
906 def getAlterationFile(filename):
907         if filename in tempOverride:
908                 return tempOverride[filename]
909         global settingsDictionary
910         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
911                 return settingsDictionary[filename].getValue()
912         traceback.print_stack()
913         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
914         return ''
915
916 def setAlterationFile(name, value):
917         #Check if we have a configuration file loaded, else load the default.
918         global settingsDictionary
919         if name in settingsDictionary and settingsDictionary[name].isAlteration():
920                 settingsDictionary[name].setValue(value)
921         saveProfile(getDefaultProfilePath())
922
923 ### Get the alteration file for output. (Used by Skeinforge)
924 def getAlterationFileContents(filename, extruderCount = 1):
925         prefix = ''
926         postfix = ''
927         alterationContents = getAlterationFile(filename)
928         if getMachineSetting('gcode_flavor') == 'UltiGCode':
929                 return ''
930         if filename == 'start.gcode':
931                 if extruderCount > 1:
932                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
933                 #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.
934                 #We also set our steps per E here, if configured.
935                 eSteps = getMachineSettingFloat('steps_per_e')
936                 if eSteps > 0:
937                         prefix += 'M92 E%f\n' % (eSteps)
938                 temp = getProfileSettingFloat('print_temperature')
939                 bedTemp = 0
940                 if getMachineSetting('has_heated_bed') == 'True':
941                         bedTemp = getProfileSettingFloat('print_bed_temperature')
942
943                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
944                         prefix += 'M140 S%f\n' % (bedTemp)
945                 if temp > 0 and not '{print_temperature}' in alterationContents:
946                         if extruderCount > 0:
947                                 for n in xrange(1, extruderCount):
948                                         t = temp
949                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
950                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
951                                         prefix += 'M104 T%d S%f\n' % (n, t)
952                                 for n in xrange(0, extruderCount):
953                                         t = temp
954                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
955                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
956                                         prefix += 'M109 T%d S%f\n' % (n, t)
957                                 prefix += 'T0\n'
958                         else:
959                                 prefix += 'M109 S%f\n' % (temp)
960                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
961                         prefix += 'M190 S%f\n' % (bedTemp)
962         elif filename == 'end.gcode':
963                 if extruderCount > 1:
964                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
965                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
966                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
967         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
968
969 ###### PLUGIN #####
970
971 def getPluginConfig():
972         try:
973                 return pickle.loads(str(getProfileSetting('plugin_config')))
974         except:
975                 return []
976
977 def setPluginConfig(config):
978         putProfileSetting('plugin_config', pickle.dumps(config))
979
980 def getPluginBasePaths():
981         ret = []
982         if platform.system() != "Windows":
983                 ret.append(os.path.expanduser('~/.cura/plugins/'))
984         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
985                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
986         else:
987                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
988         return ret
989
990 def getPluginList():
991         ret = []
992         for basePath in getPluginBasePaths():
993                 for filename in glob.glob(os.path.join(basePath, '*.py')):
994                         filename = os.path.basename(filename)
995                         if filename.startswith('_'):
996                                 continue
997                         with open(os.path.join(basePath, filename), "r") as f:
998                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
999                                 for line in f:
1000                                         line = line.strip()
1001                                         if not line.startswith('#'):
1002                                                 break
1003                                         line = line[1:].split(':', 1)
1004                                         if len(line) != 2:
1005                                                 continue
1006                                         if line[0].upper() == 'NAME':
1007                                                 item['name'] = line[1].strip()
1008                                         elif line[0].upper() == 'INFO':
1009                                                 item['info'] = line[1].strip()
1010                                         elif line[0].upper() == 'TYPE':
1011                                                 item['type'] = line[1].strip()
1012                                         elif line[0].upper() == 'DEPEND':
1013                                                 pass
1014                                         elif line[0].upper() == 'PARAM':
1015                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
1016                                                 if m is not None:
1017                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
1018                                         else:
1019                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
1020                                 if item['name'] is not None and item['type'] == 'postprocess':
1021                                         ret.append(item)
1022         return ret
1023
1024 def runPostProcessingPlugins(gcodefilename):
1025         pluginConfigList = getPluginConfig()
1026         pluginList = getPluginList()
1027
1028         for pluginConfig in pluginConfigList:
1029                 plugin = None
1030                 for pluginTest in pluginList:
1031                         if pluginTest['filename'] == pluginConfig['filename']:
1032                                 plugin = pluginTest
1033                 if plugin is None:
1034                         continue
1035
1036                 pythonFile = None
1037                 for basePath in getPluginBasePaths():
1038                         testFilename = os.path.join(basePath, pluginConfig['filename'])
1039                         if os.path.isfile(testFilename):
1040                                 pythonFile = testFilename
1041                 if pythonFile is None:
1042                         continue
1043
1044                 locals = {'filename': gcodefilename}
1045                 for param in plugin['params']:
1046                         value = param['default']
1047                         if param['name'] in pluginConfig['params']:
1048                                 value = pluginConfig['params'][param['name']]
1049
1050                         if param['type'] == 'float':
1051                                 try:
1052                                         value = float(value)
1053                                 except:
1054                                         value = float(param['default'])
1055
1056                         locals[param['name']] = value
1057                 try:
1058                         execfile(pythonFile, locals)
1059                 except:
1060                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
1061                         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])
1062         return None