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