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