chiark / gitweb /
a2f0255a17a5ed5818f67907b4a6bef1aa3391ed
[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 import numpy
8 if sys.version_info[0] < 3:
9         import ConfigParser
10 else:
11         import configparser as ConfigParser
12
13 from Cura.util import resources
14 from Cura.util import version
15 from Cura.util import validators
16
17 #The settings dictionary contains a key/value reference to all possible settings. With the setting name as key.
18 settingsDictionary = {}
19 #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,
20 # as the dictionary will not contain insertion order.
21 settingsList = []
22
23 #Currently selected machine (by index) Cura support multiple machines in the same preferences and can switch between them.
24 # Each machine has it's own index and unique name.
25 _selectedMachineIndex = 0
26
27 class setting(object):
28         #A setting object contains a configuration setting. These are globally accessible trough the quick access functions
29         # and trough the settingsDictionary function.
30         # Settings can be:
31         # * profile settings (settings that effect the slicing process and the print result)
32         # * preferences (settings that effect how cura works and acts)
33         # * machine settings (settings that relate to the physical configuration of your machine)
34         # * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
35         # Settings have validators that check if the value is valid, but do not prevent invalid values!
36         # Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
37         def __init__(self, name, default, type, category, subcategory):
38                 self._name = name
39                 self._label = name
40                 self._tooltip = ''
41                 self._default = unicode(default)
42                 self._values = []
43                 self._type = type
44                 self._category = category
45                 self._subcategory = subcategory
46                 self._validators = []
47                 self._conditions = []
48
49                 if type is types.FloatType:
50                         validators.validFloat(self)
51                 elif type is types.IntType:
52                         validators.validInt(self)
53
54                 global settingsDictionary
55                 settingsDictionary[name] = self
56                 global settingsList
57                 settingsList.append(self)
58
59         def setLabel(self, label, tooltip = ''):
60                 self._label = label
61                 self._tooltip = tooltip
62                 return self
63
64         def setRange(self, minValue=None, maxValue=None):
65                 if len(self._validators) < 1:
66                         return
67                 self._validators[0].minValue = minValue
68                 self._validators[0].maxValue = maxValue
69                 return self
70
71         def getLabel(self):
72                 return _(self._label)
73
74         def getTooltip(self):
75                 return _(self._tooltip)
76
77         def getCategory(self):
78                 return self._category
79
80         def getSubCategory(self):
81                 return self._subcategory
82
83         def isPreference(self):
84                 return self._category == 'preference'
85
86         def isMachineSetting(self):
87                 return self._category == 'machine'
88
89         def isAlteration(self):
90                 return self._category == 'alteration'
91
92         def isProfile(self):
93                 return not self.isAlteration() and not self.isPreference() and not self.isMachineSetting()
94
95         def getName(self):
96                 return self._name
97
98         def getType(self):
99                 return self._type
100
101         def getValue(self, index = None):
102                 if index is None:
103                         index = self.getValueIndex()
104                 if index >= len(self._values):
105                         return self._default
106                 return self._values[index]
107
108         def getDefault(self):
109                 return self._default
110
111         def setValue(self, value, index = None):
112                 if index is None:
113                         index = self.getValueIndex()
114                 while index >= len(self._values):
115                         self._values.append(self._default)
116                 self._values[index] = unicode(value)
117
118         def getValueIndex(self):
119                 if self.isMachineSetting():
120                         global _selectedMachineIndex
121                         return _selectedMachineIndex
122                 return 0
123
124         def validate(self):
125                 result = validators.SUCCESS
126                 msgs = []
127                 for validator in self._validators:
128                         res, err = validator.validate()
129                         if res == validators.ERROR:
130                                 result = res
131                         elif res == validators.WARNING and result != validators.ERROR:
132                                 result = res
133                         if res != validators.SUCCESS:
134                                 msgs.append(err)
135                 return result, '\n'.join(msgs)
136
137         def addCondition(self, conditionFunction):
138                 self._conditions.append(conditionFunction)
139
140         def checkConditions(self):
141                 for condition in self._conditions:
142                         if not condition():
143                                 return False
144                 return True
145
146 #########################################################
147 ## Settings
148 #########################################################
149
150 #Define a fake _() function to fake the gettext tools in to generating strings for the profile settings.
151 def _(n):
152         return n
153
154 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."))
155 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."))
156 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."))
157 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."))
158 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."))
159 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."))
160 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."))
161 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."))
162 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."))
163 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."))
164 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."))
165 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."))
166 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."))
167 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)"))
168 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."))
169 setting('wipe_tower',              False, bool,  'basic',    _('Dual extrusion')).setLabel(_("Wipe&prime tower"), _("The wipe-tower is a tower printed on every layer when switching between nozzles.\nThe old nozzle is wiped off on the tower before the new nozzle is used to print the 2nd color."))
170 setting('ooze_shield',             False, bool,  'basic',    _('Dual extrusion')).setLabel(_("Ooze shield"), _("The ooze shield is a 1 line thick shell around the object which stands a few mm from the object.\nThis shield catches any oozing from the unused nozzle in dual-extrusion."))
171 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."))
172 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."))
173 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."))
174 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."))
175 setting('filament_flow',            100., float, 'basic',    _('Filament')).setRange(5,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
176 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."))
177 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."))
178 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."))
179 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."))
180 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."))
181 setting('retraction_minimal_extrusion',0.1, 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."))
182 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."))
183 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."))
184 #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."))
185 setting('overlap_dual',             0.15, 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."))
186 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."))
187 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."))
188 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.."))
189 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."))
190 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."))
191
192 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."))
193 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."))
194 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."))
195 #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."))
196 #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.'))
197 setting('fan_full_height',           0.5, float, 'expert',   _('Cool')).setRange(0).setLabel(_("Fan full on at height (mm)"), _("The height at which the fan is turned on completely. For the layers below this the fan speed is scaled linear with the fan off at layer 0."))
198 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."))
199 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%."))
200 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."))
201 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."))
202 #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."))
203 #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')
204 #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\''))
205 #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."))
206 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."))
207 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."))
208 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."))
209 setting('support_fill_rate', 15, 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. 15% seems to be a good average."))
210 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."))
211 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."))
212 setting('spiralize', False, bool, 'expert', 'Spiralize').setLabel(_("Spiralize the outer contour"), _("Spiralize is smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. This feature turns a solid object into a single walled print with a solid bottom."))
213 #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."))
214 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."))
215 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."))
216 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."))
217 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."))
218 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."))
219 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."))
220 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."))
221 #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)."))
222 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."))
223 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."))
224 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."))
225 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."))
226
227 setting('plugin_config', '', str, 'hidden', 'hidden')
228 setting('object_center_x', -1, float, 'hidden', 'hidden')
229 setting('object_center_y', -1, float, 'hidden', 'hidden')
230
231 setting('start.gcode', """;Sliced at: {day} {date} {time}
232 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
233 ;Print time: {print_time}
234 ;Filament used: {filament_amount}m {filament_weight}g
235 ;Filament cost: {filament_cost}
236 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
237 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
238 G21        ;metric values
239 G90        ;absolute positioning
240 M107       ;start with the fan off
241
242 G28 X0 Y0  ;move X/Y to min endstops
243 G28 Z0     ;move Z to min endstops
244
245 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
246
247 G92 E0                  ;zero the extruded length
248 G1 F200 E3              ;extrude 3mm of feed stock
249 G92 E0                  ;zero the extruded length again
250 G1 F{travel_speed}
251 ;Put printing message on LCD screen
252 M117 Printing...
253 """, str, 'alteration', 'alteration')
254 #######################################################################################
255 setting('end.gcode', """;End GCode
256 M104 S0                     ;extruder heater off
257 M140 S0                     ;heated bed heater off (if you have it)
258
259 G91                                    ;relative positioning
260 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
261 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
262 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
263
264 M84                         ;steppers off
265 G90                         ;absolute positioning
266 """, str, 'alteration', 'alteration')
267 #######################################################################################
268 setting('start2.gcode', """;Sliced at: {day} {date} {time}
269 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
270 ;Print time: {print_time}
271 ;Filament used: {filament_amount}m {filament_weight}g
272 ;Filament cost: {filament_cost}
273 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
274 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
275 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
276 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
277 G21        ;metric values
278 G90        ;absolute positioning
279 M107       ;start with the fan off
280
281 G28 X0 Y0  ;move X/Y to min endstops
282 G28 Z0     ;move Z to min endstops
283
284 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
285
286 T1                      ;Switch to the 2nd extruder
287 G92 E0                  ;zero the extruded length
288 G1 F200 E10             ;extrude 10mm of feed stock
289 G92 E0                  ;zero the extruded length again
290 G1 F200 E-{retraction_dual_amount}
291
292 T0                      ;Switch to the first extruder
293 G92 E0                  ;zero the extruded length
294 G1 F200 E10             ;extrude 10mm of feed stock
295 G92 E0                  ;zero the extruded length again
296 G1 F{travel_speed}
297 ;Put printing message on LCD screen
298 M117 Printing...
299 """, str, 'alteration', 'alteration')
300 #######################################################################################
301 setting('end2.gcode', """;End GCode
302 M104 T0 S0                     ;extruder heater off
303 M104 T1 S0                     ;extruder heater off
304 M140 S0                     ;heated bed heater off (if you have it)
305
306 G91                                    ;relative positioning
307 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
308 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
309 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
310
311 M84                         ;steppers off
312 G90                         ;absolute positioning
313 """, str, 'alteration', 'alteration')
314 #######################################################################################
315 setting('support_start.gcode', '', str, 'alteration', 'alteration')
316 setting('support_end.gcode', '', str, 'alteration', 'alteration')
317 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
318 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
319 setting('replace.csv', '', str, 'alteration', 'alteration')
320 #######################################################################################
321 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
322 G92 E0
323 G1 E-36 F5000
324 G92 E0
325 T{extruder}
326 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
327 G1 E36 F5000
328 G92 E0
329 """, str, 'alteration', 'alteration')
330
331 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
332 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
333 setting('save_profile', 'False', bool, 'preference', 'hidden').setLabel(_("Save profile on slice"), _("When slicing save the profile as [stl_file]_profile.ini next to the model."))
334 setting('filament_cost_kg', '0', float, 'preference', 'hidden').setLabel(_("Cost (price/kg)"), _("Cost of your filament per kg, to estimate the cost of the final print."))
335 setting('filament_cost_meter', '0', float, 'preference', 'hidden').setLabel(_("Cost (price/m)"), _("Cost of your filament per meter, to estimate the cost of the final print."))
336 setting('auto_detect_sd', 'True', bool, 'preference', 'hidden').setLabel(_("Auto detect SD card drive"), _("Auto detect the SD card. You can disable this because on some systems external hard-drives or USB sticks are detected as SD card."))
337 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
338 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve next versions of Cura"))
339 setting('youmagine_token', '', str, 'preference', 'hidden')
340 setting('filament_physical_density', '1240', float, 'preference', 'hidden').setRange(500.0, 3000.0).setLabel(_("Density (kg/m3)"), _("Weight of the filament per m3. Around 1240 for PLA. And around 1040 for ABS. This value is used to estimate the weight if the filament used for the print."))
341 setting('language', 'English', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
342 setting('active_machine', '0', int, 'preference', 'hidden')
343
344 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel(_('Model colour'))
345 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'))
346 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'))
347 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'))
348
349 setting('window_maximized', 'True', bool, 'preference', 'hidden')
350 setting('window_pos_x', '-1', float, 'preference', 'hidden')
351 setting('window_pos_y', '-1', float, 'preference', 'hidden')
352 setting('window_width', '-1', float, 'preference', 'hidden')
353 setting('window_height', '-1', float, 'preference', 'hidden')
354 setting('window_normal_sash', '320', float, 'preference', 'hidden')
355
356 setting('machine_name', '', str, 'machine', 'hidden')
357 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
358 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Size of the machine in mm"))
359 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
360 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine in mm"))
361 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."))
362 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
363 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have an heated bed, this enabled heated bed settings (requires restart)"))
364 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."))
365 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
366 setting('extruder_offset_x1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
367 setting('extruder_offset_y1', '-21.6', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
368 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
369 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
370 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
371 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
372 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."))
373 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
374 setting('serial_port_auto', '', str, 'machine', 'hidden')
375 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"))
376 setting('serial_baud_auto', '', int, 'machine', 'hidden')
377
378 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."))
379 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."))
380 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."))
381 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."))
382 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."))
383
384 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
385 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
386 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."))
387 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
388 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
389 validators.printSpeedValidator(settingsDictionary['print_speed'])
390 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
391 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
392 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
393 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
394 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
395 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
396 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
397 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
398 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
399 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."))
400
401 #Conditions for multiple extruders
402 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
403 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
404 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
405 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
406 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
407 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
408 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
409 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
410 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
411 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
412 #Heated bed
413 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
414
415 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
416 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
417 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
418 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
419 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
420 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
421 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
422 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
423 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
424 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
425 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
426 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
427 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
428 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
429
430 #Remove fake defined _() because later the localization will define a global _()
431 del _
432
433 #########################################################
434 ## Profile and preferences functions
435 #########################################################
436
437 def getSubCategoriesFor(category):
438         done = {}
439         ret = []
440         for s in settingsList:
441                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
442                         done[s.getSubCategory()] = True
443                         ret.append(s.getSubCategory())
444         return ret
445
446 def getSettingsForCategory(category, subCategory = None):
447         ret = []
448         for s in settingsList:
449                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
450                         ret.append(s)
451         return ret
452
453 ## Profile functions
454 def getBasePath():
455         if platform.system() == "Windows":
456                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
457                 #If we have a frozen python install, we need to step out of the library.zip
458                 if hasattr(sys, 'frozen'):
459                         basePath = os.path.normpath(os.path.join(basePath, ".."))
460         else:
461                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
462         if not os.path.isdir(basePath):
463                 os.makedirs(basePath)
464         return basePath
465
466 def getAlternativeBasePaths():
467         paths = []
468         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
469         for subPath in os.listdir(basePath):
470                 path = os.path.join(basePath, subPath)
471                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
472                         paths.append(path)
473                 path = os.path.join(basePath, subPath, 'Cura')
474                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
475                         paths.append(path)
476         return paths
477
478 def getDefaultProfilePath():
479         return os.path.join(getBasePath(), 'current_profile.ini')
480
481 def loadProfile(filename):
482         #Read a configuration file as global config
483         profileParser = ConfigParser.ConfigParser()
484         try:
485                 profileParser.read(filename)
486         except ConfigParser.ParsingError:
487                 return
488         global settingsList
489         for set in settingsList:
490                 if set.isPreference():
491                         continue
492                 section = 'profile'
493                 if set.isAlteration():
494                         section = 'alterations'
495                 if profileParser.has_option(section, set.getName()):
496                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
497
498 def saveProfile(filename):
499         #Save the current profile to an ini file
500         profileParser = ConfigParser.ConfigParser()
501         profileParser.add_section('profile')
502         profileParser.add_section('alterations')
503         global settingsList
504         for set in settingsList:
505                 if set.isPreference() or set.isMachineSetting():
506                         continue
507                 if set.isAlteration():
508                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
509                 else:
510                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
511
512         profileParser.write(open(filename, 'w'))
513
514 def resetProfile():
515         #Read a configuration file as global config
516         global settingsList
517         for set in settingsList:
518                 if not set.isProfile():
519                         continue
520                 set.setValue(set.getDefault())
521
522         if getMachineSetting('machine_type') == 'ultimaker':
523                 putProfileSetting('nozzle_size', '0.4')
524                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
525                         putProfileSetting('retraction_enable', 'True')
526         elif getMachineSetting('machine_type') == 'ultimaker2':
527                 putProfileSetting('nozzle_size', '0.4')
528                 putProfileSetting('retraction_enable', 'True')
529         else:
530                 putProfileSetting('nozzle_size', '0.5')
531                 putProfileSetting('retraction_enable', 'True')
532
533 def setProfileFromString(options):
534         options = base64.b64decode(options)
535         options = zlib.decompress(options)
536         (profileOpts, alt) = options.split('\f', 1)
537         global settingsDictionary
538         for option in profileOpts.split('\b'):
539                 if len(option) > 0:
540                         (key, value) = option.split('=', 1)
541                         if key in settingsDictionary:
542                                 if settingsDictionary[key].isProfile():
543                                         settingsDictionary[key].setValue(value)
544         for option in alt.split('\b'):
545                 if len(option) > 0:
546                         (key, value) = option.split('=', 1)
547                         if key in settingsDictionary:
548                                 if settingsDictionary[key].isAlteration():
549                                         settingsDictionary[key].setValue(value)
550
551 def getProfileString():
552         p = []
553         alt = []
554         global settingsList
555         for set in settingsList:
556                 if set.isProfile():
557                         if set.getName() in tempOverride:
558                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
559                         else:
560                                 p.append(set.getName() + "=" + set.getValue())
561                 elif set.isAlteration():
562                         if set.getName() in tempOverride:
563                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
564                         else:
565                                 alt.append(set.getName() + "=" + set.getValue())
566         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
567         ret = base64.b64encode(zlib.compress(ret, 9))
568         return ret
569
570 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
571         lines = []
572         for i in xrange(0, len(string), every):
573                 lines.append(string[i:i+every])
574         return '\n'.join(lines)
575
576 def getPreferencesString():
577         p = []
578         global settingsList
579         for set in settingsList:
580                 if set.isPreference():
581                         p.append(set.getName() + "=" + set.getValue())
582         ret = '\b'.join(p)
583         ret = base64.b64encode(zlib.compress(ret, 9))
584         return ret
585
586
587 def getProfileSetting(name):
588         if name in tempOverride:
589                 return tempOverride[name]
590         global settingsDictionary
591         if name in settingsDictionary and settingsDictionary[name].isProfile():
592                 return settingsDictionary[name].getValue()
593         traceback.print_stack()
594         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
595         return ''
596
597 def getProfileSettingFloat(name):
598         try:
599                 setting = getProfileSetting(name).replace(',', '.')
600                 return float(eval(setting, {}, {}))
601         except:
602                 return 0.0
603
604 def putProfileSetting(name, value):
605         #Check if we have a configuration file loaded, else load the default.
606         global settingsDictionary
607         if name in settingsDictionary and settingsDictionary[name].isProfile():
608                 settingsDictionary[name].setValue(value)
609
610 def isProfileSetting(name):
611         global settingsDictionary
612         if name in settingsDictionary and settingsDictionary[name].isProfile():
613                 return True
614         return False
615
616 ## Preferences functions
617 def getPreferencePath():
618         return os.path.join(getBasePath(), 'preferences.ini')
619
620 def getPreferenceFloat(name):
621         try:
622                 setting = getPreference(name).replace(',', '.')
623                 return float(eval(setting, {}, {}))
624         except:
625                 return 0.0
626
627 def getPreferenceColour(name):
628         colorString = getPreference(name)
629         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
630
631 def loadPreferences(filename):
632         global settingsList
633         #Read a configuration file as global config
634         profileParser = ConfigParser.ConfigParser()
635         try:
636                 profileParser.read(filename)
637         except ConfigParser.ParsingError:
638                 return
639
640         for set in settingsList:
641                 if set.isPreference():
642                         if profileParser.has_option('preference', set.getName()):
643                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
644
645         n = 0
646         while profileParser.has_section('machine_%d' % (n)):
647                 for set in settingsList:
648                         if set.isMachineSetting():
649                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
650                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
651                 n += 1
652
653         setActiveMachine(int(getPreferenceFloat('active_machine')))
654
655 def loadMachineSettings(filename):
656         global settingsList
657         #Read a configuration file as global config
658         profileParser = ConfigParser.ConfigParser()
659         try:
660                 profileParser.read(filename)
661         except ConfigParser.ParsingError:
662                 return
663
664         for set in settingsList:
665                 if set.isMachineSetting():
666                         if profileParser.has_option('machine', set.getName()):
667                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
668         checkAndUpdateMachineName()
669
670 def savePreferences(filename):
671         global settingsList
672         #Save the current profile to an ini file
673         parser = ConfigParser.ConfigParser()
674         parser.add_section('preference')
675
676         for set in settingsList:
677                 if set.isPreference():
678                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
679
680         n = 0
681         while getMachineSetting('machine_name', n) != '':
682                 parser.add_section('machine_%d' % (n))
683                 for set in settingsList:
684                         if set.isMachineSetting():
685                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
686                 n += 1
687         parser.write(open(filename, 'w'))
688
689 def getPreference(name):
690         if name in tempOverride:
691                 return tempOverride[name]
692         global settingsDictionary
693         if name in settingsDictionary and settingsDictionary[name].isPreference():
694                 return settingsDictionary[name].getValue()
695         traceback.print_stack()
696         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
697         return ''
698
699 def putPreference(name, value):
700         #Check if we have a configuration file loaded, else load the default.
701         global settingsDictionary
702         if name in settingsDictionary and settingsDictionary[name].isPreference():
703                 settingsDictionary[name].setValue(value)
704                 savePreferences(getPreferencePath())
705                 return
706         traceback.print_stack()
707         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
708
709 def isPreference(name):
710         global settingsDictionary
711         if name in settingsDictionary and settingsDictionary[name].isPreference():
712                 return True
713         return False
714
715 def getMachineSettingFloat(name):
716         try:
717                 setting = getMachineSetting(name).replace(',', '.')
718                 return float(eval(setting, {}, {}))
719         except:
720                 return 0.0
721
722 def getMachineSetting(name, index = None):
723         if name in tempOverride:
724                 return tempOverride[name]
725         global settingsDictionary
726         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
727                 return settingsDictionary[name].getValue(index)
728         traceback.print_stack()
729         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
730         return ''
731
732 def putMachineSetting(name, value):
733         #Check if we have a configuration file loaded, else load the default.
734         global settingsDictionary
735         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
736                 settingsDictionary[name].setValue(value)
737         savePreferences(getPreferencePath())
738
739 def isMachineSetting(name):
740         global settingsDictionary
741         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
742                 return True
743         return False
744
745 def checkAndUpdateMachineName():
746         global _selectedMachineIndex
747         name = getMachineSetting('machine_name')
748         index = None
749         if name == '':
750                 name = getMachineSetting('machine_type')
751         for n in xrange(0, getMachineCount()):
752                 if n == _selectedMachineIndex:
753                         continue
754                 if index is None:
755                         if name == getMachineSetting('machine_name', n):
756                                 index = 1
757                 else:
758                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
759                                 index += 1
760         if index is not None:
761                 name = '%s (%d)' % (name, index)
762         putMachineSetting('machine_name', name)
763         putPreference('active_machine', _selectedMachineIndex)
764
765 def getMachineCount():
766         n = 0
767         while getMachineSetting('machine_name', n) != '':
768                 n += 1
769         if n < 1:
770                 return 1
771         return n
772
773 def setActiveMachine(index):
774         global _selectedMachineIndex
775         _selectedMachineIndex = index
776         putPreference('active_machine', _selectedMachineIndex)
777
778 def removeMachine(index):
779         global _selectedMachineIndex
780         global settingsList
781         if getMachineCount() < 2:
782                 return
783         for n in xrange(index, getMachineCount()):
784                 for setting in settingsList:
785                         if setting.isMachineSetting():
786                                 setting.setValue(setting.getValue(n+1), n)
787
788         if _selectedMachineIndex >= index:
789                 setActiveMachine(getMachineCount() - 1)
790
791 ## Temp overrides for multi-extruder slicing and the project planner.
792 tempOverride = {}
793 def setTempOverride(name, value):
794         tempOverride[name] = unicode(value).encode("utf-8")
795 def clearTempOverride(name):
796         del tempOverride[name]
797 def resetTempOverride():
798         tempOverride.clear()
799
800 #########################################################
801 ## Utility functions to calculate common profile values
802 #########################################################
803 def calculateEdgeWidth():
804         wallThickness = getProfileSettingFloat('wall_thickness')
805         nozzleSize = getProfileSettingFloat('nozzle_size')
806
807         if getProfileSetting('spiralize') == 'True':
808                 return wallThickness
809
810         if wallThickness < 0.01:
811                 return nozzleSize
812         if wallThickness < nozzleSize:
813                 return wallThickness
814
815         lineCount = int(wallThickness / (nozzleSize - 0.0001))
816         if lineCount == 0:
817                 return nozzleSize
818         lineWidth = wallThickness / lineCount
819         lineWidthAlt = wallThickness / (lineCount + 1)
820         if lineWidth > nozzleSize * 1.5:
821                 return lineWidthAlt
822         return lineWidth
823
824 def calculateLineCount():
825         wallThickness = getProfileSettingFloat('wall_thickness')
826         nozzleSize = getProfileSettingFloat('nozzle_size')
827
828         if wallThickness < 0.01:
829                 return 0
830         if wallThickness < nozzleSize:
831                 return 1
832         if getProfileSetting('spiralize') == 'True':
833                 return 1
834
835         lineCount = int(wallThickness / (nozzleSize - 0.0001))
836         if lineCount < 1:
837                 lineCount = 1
838         lineWidth = wallThickness / lineCount
839         lineWidthAlt = wallThickness / (lineCount + 1)
840         if lineWidth > nozzleSize * 1.5:
841                 return lineCount + 1
842         return lineCount
843
844 def calculateSolidLayerCount():
845         layerHeight = getProfileSettingFloat('layer_height')
846         solidThickness = getProfileSettingFloat('solid_layer_thickness')
847         if layerHeight == 0.0:
848                 return 1
849         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
850
851 def calculateObjectSizeOffsets():
852         size = 0.0
853
854         if getProfileSetting('platform_adhesion') == 'Brim':
855                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
856         elif getProfileSetting('platform_adhesion') == 'Raft':
857                 pass
858         else:
859                 if getProfileSettingFloat('skirt_line_count') > 0:
860                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
861
862         #if getProfileSetting('enable_raft') != 'False':
863         #       size += profile.getProfileSettingFloat('raft_margin') * 2
864         #if getProfileSetting('support') != 'None':
865         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
866         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
867         return [size, size]
868
869 def getMachineCenterCoords():
870         if getMachineSetting('machine_center_is_zero') == 'True':
871                 return [0, 0]
872         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
873
874 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
875 # the rest of the polygons are the dis-allowed areas of the machine.
876 def getMachineSizePolygons():
877         size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
878         ret = []
879         ret.append(numpy.array([[-size[0]/2,-size[1]/2],[ size[0]/2,-size[1]/2],[ size[0]/2, size[1]/2], [-size[0]/2, size[1]/2]], numpy.float32))
880
881         # Circle platform for delta printers...
882         # circle = []
883         # steps = 16
884         # for n in xrange(0, steps):
885         #       circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[0]/2])
886         # ret.append(numpy.array(circle, numpy.float32))
887
888         if getMachineSetting('machine_type') == 'ultimaker2':
889                 #UM2 no-go zones
890                 w = 25
891                 h = 10
892                 ret.append(numpy.array([[-size[0]/2,-size[1]/2],[-size[0]/2+w+2,-size[1]/2], [-size[0]/2+w,-size[1]/2+h], [-size[0]/2,-size[1]/2+h]], numpy.float32))
893                 ret.append(numpy.array([[ size[0]/2-w-2,-size[1]/2],[ size[0]/2,-size[1]/2], [ size[0]/2,-size[1]/2+h],[ size[0]/2-w,-size[1]/2+h]], numpy.float32))
894                 ret.append(numpy.array([[-size[0]/2+w+2, size[1]/2],[-size[0]/2, size[1]/2], [-size[0]/2, size[1]/2-h],[-size[0]/2+w, size[1]/2-h]], numpy.float32))
895                 ret.append(numpy.array([[ size[0]/2, size[1]/2],[ size[0]/2-w-2, size[1]/2], [ size[0]/2-w, size[1]/2-h],[ size[0]/2, size[1]/2-h]], numpy.float32))
896         return ret
897
898 #########################################################
899 ## Alteration file functions
900 #########################################################
901 def replaceTagMatch(m):
902         pre = m.group(1)
903         tag = m.group(2)
904         if tag == 'time':
905                 return pre + time.strftime('%H:%M:%S')
906         if tag == 'date':
907                 return pre + time.strftime('%d-%m-%Y')
908         if tag == 'day':
909                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
910         if tag == 'print_time':
911                 return pre + '#P_TIME#'
912         if tag == 'filament_amount':
913                 return pre + '#F_AMNT#'
914         if tag == 'filament_weight':
915                 return pre + '#F_WGHT#'
916         if tag == 'filament_cost':
917                 return pre + '#F_COST#'
918         if pre == 'F' and tag == 'max_z_speed':
919                 f = getProfileSettingFloat('travel_speed') * 60
920         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
921                 f = getProfileSettingFloat(tag) * 60
922         elif isProfileSetting(tag):
923                 f = getProfileSettingFloat(tag)
924         elif isPreference(tag):
925                 f = getProfileSettingFloat(tag)
926         else:
927                 return '%s?%s?' % (pre, tag)
928         if (f % 1) == 0:
929                 return pre + str(int(f))
930         return pre + str(f)
931
932 def replaceGCodeTags(filename, gcodeInt):
933         f = open(filename, 'r+')
934         data = f.read(2048)
935         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
936         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
937         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
938         cost = gcodeInt.calculateCost()
939         if cost is None:
940                 cost = 'Unknown'
941         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
942         f.seek(0)
943         f.write(data)
944         f.close()
945
946 def replaceGCodeTagsFromSlicer(filename, slicerInt):
947         f = open(filename, 'r+')
948         data = f.read(2048)
949         data = data.replace('#P_TIME#', slicerInt.getPrintTime())
950         data = data.replace('#F_AMNT#', slicerInt.getFilamentAmount())
951         data = data.replace('#F_WGHT#', ('%8.2f' % (float(slicerInt.getFilamentWeight()) * 1000))[-8:])
952         cost = slicerInt.getFilamentCost()
953         if cost is None:
954                 cost = 'Unknown'
955         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
956         f.seek(0)
957         f.write(data)
958         f.close()
959
960 ### Get aleration raw contents. (Used internally in Cura)
961 def getAlterationFile(filename):
962         if filename in tempOverride:
963                 return tempOverride[filename]
964         global settingsDictionary
965         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
966                 return settingsDictionary[filename].getValue()
967         traceback.print_stack()
968         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
969         return ''
970
971 def setAlterationFile(name, value):
972         #Check if we have a configuration file loaded, else load the default.
973         global settingsDictionary
974         if name in settingsDictionary and settingsDictionary[name].isAlteration():
975                 settingsDictionary[name].setValue(value)
976         saveProfile(getDefaultProfilePath())
977
978 def isTagIn(tag, contents):
979         contents = re.sub(';[^\n]*\n', '', contents)
980         return tag in contents
981
982 ### Get the alteration file for output. (Used by Skeinforge)
983 def getAlterationFileContents(filename, extruderCount = 1):
984         prefix = ''
985         postfix = ''
986         alterationContents = getAlterationFile(filename)
987         if getMachineSetting('gcode_flavor') == 'UltiGCode':
988                 if filename == 'end.gcode':
989                         return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
990                 return ''
991         if filename == 'start.gcode':
992                 if extruderCount > 1:
993                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
994                 #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.
995                 #We also set our steps per E here, if configured.
996                 eSteps = getMachineSettingFloat('steps_per_e')
997                 if eSteps > 0:
998                         prefix += 'M92 E%f\n' % (eSteps)
999                 temp = getProfileSettingFloat('print_temperature')
1000                 bedTemp = 0
1001                 if getMachineSetting('has_heated_bed') == 'True':
1002                         bedTemp = getProfileSettingFloat('print_bed_temperature')
1003
1004                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1005                         prefix += 'M140 S%f\n' % (bedTemp)
1006                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1007                         if extruderCount > 0:
1008                                 for n in xrange(1, extruderCount):
1009                                         t = temp
1010                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1011                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1012                                         prefix += 'M104 T%d S%f\n' % (n, t)
1013                                 for n in xrange(0, extruderCount):
1014                                         t = temp
1015                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1016                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1017                                         prefix += 'M109 T%d S%f\n' % (n, t)
1018                                 prefix += 'T0\n'
1019                         else:
1020                                 prefix += 'M109 S%f\n' % (temp)
1021                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1022                         prefix += 'M190 S%f\n' % (bedTemp)
1023         elif filename == 'end.gcode':
1024                 if extruderCount > 1:
1025                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1026                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1027                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1028         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
1029
1030 ###### PLUGIN #####
1031
1032 def getPluginConfig():
1033         try:
1034                 return pickle.loads(str(getProfileSetting('plugin_config')))
1035         except:
1036                 return []
1037
1038 def setPluginConfig(config):
1039         putProfileSetting('plugin_config', pickle.dumps(config))
1040
1041 def getPluginBasePaths():
1042         ret = []
1043         if platform.system() != "Windows":
1044                 ret.append(os.path.expanduser('~/.cura/plugins/'))
1045         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
1046                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
1047         else:
1048                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
1049         return ret
1050
1051 def getPluginList():
1052         ret = []
1053         for basePath in getPluginBasePaths():
1054                 for filename in glob.glob(os.path.join(basePath, '*.py')):
1055                         filename = os.path.basename(filename)
1056                         if filename.startswith('_'):
1057                                 continue
1058                         with open(os.path.join(basePath, filename), "r") as f:
1059                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
1060                                 for line in f:
1061                                         line = line.strip()
1062                                         if not line.startswith('#'):
1063                                                 break
1064                                         line = line[1:].split(':', 1)
1065                                         if len(line) != 2:
1066                                                 continue
1067                                         if line[0].upper() == 'NAME':
1068                                                 item['name'] = line[1].strip()
1069                                         elif line[0].upper() == 'INFO':
1070                                                 item['info'] = line[1].strip()
1071                                         elif line[0].upper() == 'TYPE':
1072                                                 item['type'] = line[1].strip()
1073                                         elif line[0].upper() == 'DEPEND':
1074                                                 pass
1075                                         elif line[0].upper() == 'PARAM':
1076                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
1077                                                 if m is not None:
1078                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
1079                                         else:
1080                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
1081                                 if item['name'] is not None and item['type'] == 'postprocess':
1082                                         ret.append(item)
1083         return ret
1084
1085 def runPostProcessingPlugins(gcodefilename):
1086         pluginConfigList = getPluginConfig()
1087         pluginList = getPluginList()
1088
1089         for pluginConfig in pluginConfigList:
1090                 plugin = None
1091                 for pluginTest in pluginList:
1092                         if pluginTest['filename'] == pluginConfig['filename']:
1093                                 plugin = pluginTest
1094                 if plugin is None:
1095                         continue
1096
1097                 pythonFile = None
1098                 for basePath in getPluginBasePaths():
1099                         testFilename = os.path.join(basePath, pluginConfig['filename'])
1100                         if os.path.isfile(testFilename):
1101                                 pythonFile = testFilename
1102                 if pythonFile is None:
1103                         continue
1104
1105                 locals = {'filename': gcodefilename}
1106                 for param in plugin['params']:
1107                         value = param['default']
1108                         if param['name'] in pluginConfig['params']:
1109                                 value = pluginConfig['params'][param['name']]
1110
1111                         if param['type'] == 'float':
1112                                 try:
1113                                         value = float(value)
1114                                 except:
1115                                         value = float(param['default'])
1116
1117                         locals[param['name']] = value
1118                 try:
1119                         execfile(pythonFile, locals)
1120                 except:
1121                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
1122                         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])
1123         return None