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