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