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