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