chiark / gitweb /
Merge pull request #557 from GreatFruitOmsk/i18n
[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 settingsDictionary = {}
17 settingsList = []
18 class setting(object):
19         def __init__(self, name, default, type, category, subcategory):
20                 self._name = name
21                 self._label = name
22                 self._tooltip = ''
23                 self._default = unicode(default)
24                 self._value = self._default
25                 self._type = type
26                 self._category = category
27                 self._subcategory = subcategory
28                 self._validators = []
29                 self._conditions = []
30
31                 if type is types.FloatType:
32                         validators.validFloat(self)
33                 elif type is types.IntType:
34                         validators.validInt(self)
35
36                 global settingsDictionary
37                 settingsDictionary[name] = self
38                 global settingsList
39                 settingsList.append(self)
40
41         def setLabel(self, label, tooltip = ''):
42                 self._label = label
43                 self._tooltip = tooltip
44                 return self
45
46         def setRange(self, minValue = None, maxValue = None):
47                 if len(self._validators) < 1:
48                         return
49                 self._validators[0].minValue = minValue
50                 self._validators[0].maxValue = maxValue
51                 return self
52
53         def getLabel(self):
54                 return self._label
55
56         def getTooltip(self):
57                 return self._tooltip
58
59         def getCategory(self):
60                 return self._category
61
62         def getSubCategory(self):
63                 return self._subcategory
64
65         def isPreference(self):
66                 return self._category == 'preference'
67
68         def isAlteration(self):
69                 return self._category == 'alteration'
70
71         def isProfile(self):
72                 return not self.isAlteration() and not self.isPreference()
73
74         def getName(self):
75                 return self._name
76
77         def getType(self):
78                 return self._type
79
80         def getValue(self):
81                 return self._value
82
83         def getDefault(self):
84                 return self._default
85
86         def setValue(self, value):
87                 self._value = unicode(value)
88
89         def validate(self):
90                 result = validators.SUCCESS
91                 msgs = []
92                 for validator in self._validators:
93                         res, err = validator.validate()
94                         if res == validators.ERROR:
95                                 result = res
96                         elif res == validators.WARNING and result != validators.ERROR:
97                                 result = res
98                         if res != validators.SUCCESS:
99                                 msgs.append(err)
100                 return result, '\n'.join(msgs)
101
102         def addCondition(self, conditionFunction):
103                 self._conditions.append(conditionFunction)
104
105         def checkConditions(self):
106                 for condition in self._conditions:
107                         if not condition():
108                                 return False
109                 return True
110
111 #########################################################
112 ## Settings
113 #########################################################
114 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."))
115 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."))
116 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."))
117 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."))
118 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."))
119 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."))
120 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."))
121 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."))
122 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."))
123 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."))
124 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."))
125 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."))
126 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."))
127 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)"))
128 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."))
129 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."))
130 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."))
131 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."))
132 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."))
133 setting('filament_flow',            100., float, 'basic',    'Filament').setRange(1,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
134 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."))
135 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."))
136 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."))
137 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."))
138 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."))
139 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."))
140 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."))
141 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."))
142 #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.')
143 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."))
144 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."))
145 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."))
146 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.."))
147 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."))
148 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."))
149
150 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."))
151 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."))
152 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."))
153 #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.')
154 #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.')
155 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."))
156 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."))
157 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%."))
158 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."))
159 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."))
160 #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.')
161 #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')
162 #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\'')
163 #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.')
164 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."))
165 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."))
166 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."))
167 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."))
168 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."))
169 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."))
170 #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.')
171 #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.')
172 #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.')
173 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."))
174 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."))
175 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."))
176 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."))
177 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."))
178 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."))
179 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."))
180 #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).')
181 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."))
182 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."))
183 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."))
184 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."))
185
186 setting('plugin_config', '', str, 'hidden', 'hidden')
187 setting('object_center_x', -1, float, 'hidden', 'hidden')
188 setting('object_center_y', -1, float, 'hidden', 'hidden')
189
190 setting('start.gcode', """;Sliced at: {day} {date} {time}
191 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
192 ;Print time: {print_time}
193 ;Filament used: {filament_amount}m {filament_weight}g
194 ;Filament cost: {filament_cost}
195 G21        ;metric values
196 G90        ;absolute positioning
197 M107       ;start with the fan off
198
199 G28 X0 Y0  ;move X/Y to min endstops
200 G28 Z0     ;move Z to min endstops
201
202 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
203
204 G92 E0                  ;zero the extruded length
205 G1 F200 E3              ;extrude 3mm of feed stock
206 G92 E0                  ;zero the extruded length again
207 G1 F{travel_speed}
208 M117 Printing...
209 """, str, 'alteration', 'alteration')
210 #######################################################################################
211 setting('end.gcode', """;End GCode
212 M104 S0                     ;extruder heater off
213 M140 S0                     ;heated bed heater off (if you have it)
214
215 G91                                    ;relative positioning
216 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
217 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
218 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
219
220 M84                         ;steppers off
221 G90                         ;absolute positioning
222 """, str, 'alteration', 'alteration')
223 #######################################################################################
224 setting('start2.gcode', """;Sliced at: {day} {date} {time}
225 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
226 ;Print time: {print_time}
227 ;Filament used: {filament_amount}m {filament_weight}g
228 ;Filament cost: {filament_cost}
229 G21        ;metric values
230 G90        ;absolute positioning
231 M107       ;start with the fan off
232
233 G28 X0 Y0  ;move X/Y to min endstops
234 G28 Z0     ;move Z to min endstops
235
236 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
237
238 T1
239 G92 E0                  ;zero the extruded length
240 G1 F200 E10             ;extrude 10mm of feed stock
241 G92 E0                  ;zero the extruded length again
242 G1 F200 E-{retraction_dual_amount}
243
244 T0
245 G92 E0                  ;zero the extruded length
246 G1 F200 E10              ;extrude 10mm of feed stock
247 G92 E0                  ;zero the extruded length again
248 G1 F{travel_speed}
249 M117 Printing...
250 """, str, 'alteration', 'alteration')
251 #######################################################################################
252 setting('end2.gcode', """;End GCode
253 M104 T0 S0                     ;extruder heater off
254 M104 T1 S0                     ;extruder heater off
255 M140 S0                     ;heated bed heater off (if you have it)
256
257 G91                                    ;relative positioning
258 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
259 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
260 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
261
262 M84                         ;steppers off
263 G90                         ;absolute positioning
264 """, str, 'alteration', 'alteration')
265 #######################################################################################
266 setting('support_start.gcode', '', str, 'alteration', 'alteration')
267 setting('support_end.gcode', '', str, 'alteration', 'alteration')
268 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
269 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
270 setting('replace.csv', '', str, 'alteration', 'alteration')
271 #######################################################################################
272 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.
273 G92 E0
274
275 G91                                    ;relative positioning
276 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
277 G1 Z+0.5 E-5 F{travel_speed}           ;move Z up a bit and retract filament even more
278 G90                                    ;absolute positioning
279
280 G1 Z{clear_z} F{max_z_speed}
281 G92 E0
282 G1 X{object_center_x} Y{object_center_y} F{travel_speed}
283 G1 F200 E6
284 G92 E0
285 """, str, 'alteration', 'alteration')
286 #######################################################################################
287 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
288 G92 E0
289 G1 E-36 F5000
290 G92 E0
291 T{extruder}
292 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
293 G1 E36 F5000
294 G92 E0
295 """, str, 'alteration', 'alteration')
296
297 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
298 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
299 setting('machine_width', '205', float, 'preference', 'hidden').setLabel('Maximum width (mm)', 'Size of the machine in mm')
300 setting('machine_depth', '205', float, 'preference', 'hidden').setLabel('Maximum depth (mm)', 'Size of the machine in mm')
301 setting('machine_height', '200', float, 'preference', 'hidden').setLabel('Maximum height (mm)', 'Size of the machine in mm')
302 setting('machine_type', 'unknown', str, 'preference', 'hidden')
303 setting('machine_center_is_zero', 'False', bool, 'preference', 'hidden')
304 setting('ultimaker_extruder_upgrade', 'False', bool, 'preference', 'hidden')
305 setting('has_heated_bed', 'False', bool, 'preference', 'hidden').setLabel('Heated bed', 'If you have an heated bed, this enabled heated bed settings (requires restart)')
306 setting('machine_type', 'unknown', str, 'preference', 'hidden')
307 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode'], 'preference', 'hidden').setLabel('GCode Flavor', 'Flavor of generated GCode.\nRepRap...')
308 setting('extruder_amount', '1', ['1','2','3','4'], 'preference', 'hidden').setLabel('Extruder count', 'Amount of extruders in your machine.')
309 setting('extruder_offset_x1', '-21.6', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
310 setting('extruder_offset_y1', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
311 setting('extruder_offset_x2', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
312 setting('extruder_offset_y2', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
313 setting('extruder_offset_x3', '0.0', float, 'preference', 'hidden').setLabel('Offset X', 'The offset of your secondary extruder compared to the primary.')
314 setting('extruder_offset_y3', '0.0', float, 'preference', 'hidden').setLabel('Offset Y', 'The offset of your secondary extruder compared to the primary.')
315 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.')
316 setting('steps_per_e', '0', float, 'preference', '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.')
317 setting('serial_port', 'AUTO', str, 'preference', 'hidden').setLabel('Serial port', 'Serial port to use for communication with the printer')
318 setting('serial_port_auto', '', str, 'preference', 'hidden')
319 setting('serial_baud', 'AUTO', str, 'preference', 'hidden').setLabel('Baudrate', 'Speed of the serial port communication\nNeeds to match your firmware settings\nCommon values are 250000, 115200, 57600')
320 setting('serial_baud_auto', '', int, 'preference', 'hidden')
321 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.')
322 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.')
323 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.')
324 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.')
325 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel('Check for updates', 'Check for newer versions of Cura on startup')
326 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel('Send usage statistics', 'Submit anonymous usage information to improve next versions of Cura')
327 setting('youmagine_token', '', str, 'preference', 'hidden')
328
329 setting('extruder_head_size_min_x', '0.0', float, 'preference', '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.')
330 setting('extruder_head_size_min_y', '0.0', float, 'preference', '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.')
331 setting('extruder_head_size_max_x', '0.0', float, 'preference', '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.')
332 setting('extruder_head_size_max_y', '0.0', float, 'preference', '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.')
333 setting('extruder_head_size_height', '0.0', float, 'preference', '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.')
334
335 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel('Model colour')
336 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel('Model colour (2)')
337 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel('Model colour (3)')
338 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel('Model colour (4)')
339
340 setting('window_maximized', 'True', bool, 'preference', 'hidden')
341 setting('window_pos_x', '-1', float, 'preference', 'hidden')
342 setting('window_pos_y', '-1', float, 'preference', 'hidden')
343 setting('window_width', '-1', float, 'preference', 'hidden')
344 setting('window_height', '-1', float, 'preference', 'hidden')
345 setting('window_normal_sash', '320', float, 'preference', 'hidden')
346
347 validators.warningAbove(settingsDictionary['filament_flow'], 150, "More flow then 150% is rare and usually not recommended.")
348 validators.warningBelow(settingsDictionary['filament_flow'], 50, "More flow then 50% is rare and usually not recommended.")
349 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.")
350 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
351 validators.warningAbove(settingsDictionary['print_speed'], 150.0, "It is highly unlikely that your machine can achieve a printing speed above 150mm/s")
352 validators.printSpeedValidator(settingsDictionary['print_speed'])
353 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
354 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
355 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
356 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, "Temperatures above 260C could damage your machine, be careful!")
357 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
358 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
359 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
360 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, "Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm.")
361 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, "It is highly unlikely that your machine can achieve a travel speed above 300mm/s")
362 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.")
363
364 #Conditions for multiple extruders
365 settingsDictionary['print_temperature2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
366 settingsDictionary['print_temperature3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
367 settingsDictionary['print_temperature4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
368 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
369 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getPreference('extruder_amount')) > 2)
370 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getPreference('extruder_amount')) > 3)
371 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
372 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getPreference('extruder_amount')) > 1)
373 #Heated bed
374 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('has_heated_bed') == 'True')
375
376 #UltiGCode uses less settings
377 settingsDictionary['print_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
378 settingsDictionary['print_temperature2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
379 settingsDictionary['print_temperature3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
380 settingsDictionary['print_temperature4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
381 settingsDictionary['filament_diameter'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
382 settingsDictionary['filament_diameter2'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
383 settingsDictionary['filament_diameter3'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
384 settingsDictionary['filament_diameter4'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
385 settingsDictionary['filament_flow'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
386 settingsDictionary['print_bed_temperature'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
387 settingsDictionary['retraction_speed'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
388 settingsDictionary['retraction_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
389 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getPreference('gcode_flavor') != 'UltiGCode')
390
391 #########################################################
392 ## Profile and preferences functions
393 #########################################################
394
395 def getSubCategoriesFor(category):
396         done = {}
397         ret = []
398         for s in settingsList:
399                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
400                         done[s.getSubCategory()] = True
401                         ret.append(s.getSubCategory())
402         return ret
403
404 def getSettingsForCategory(category, subCategory = None):
405         ret = []
406         for s in settingsList:
407                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
408                         ret.append(s)
409         return ret
410
411 ## Profile functions
412 def getBasePath():
413         if platform.system() == "Windows":
414                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
415                 #If we have a frozen python install, we need to step out of the library.zip
416                 if hasattr(sys, 'frozen'):
417                         basePath = os.path.normpath(os.path.join(basePath, ".."))
418         else:
419                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
420         if not os.path.isdir(basePath):
421                 os.makedirs(basePath)
422         return basePath
423
424 def getAlternativeBasePaths():
425         paths = []
426         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
427         for subPath in os.listdir(basePath):
428                 path = os.path.join(basePath, subPath)
429                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
430                         paths.append(path)
431                 path = os.path.join(basePath, subPath, 'Cura')
432                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
433                         paths.append(path)
434         return paths
435
436 def getDefaultProfilePath():
437         return os.path.join(getBasePath(), 'current_profile.ini')
438
439 def loadProfile(filename):
440         #Read a configuration file as global config
441         profileParser = ConfigParser.ConfigParser()
442         try:
443                 profileParser.read(filename)
444         except ConfigParser.ParsingError:
445                 return
446         global settingsList
447         for set in settingsList:
448                 if set.isPreference():
449                         continue
450                 section = 'profile'
451                 if set.isAlteration():
452                         section = 'alterations'
453                 if profileParser.has_option(section, set.getName()):
454                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
455
456 def saveProfile(filename):
457         #Save the current profile to an ini file
458         profileParser = ConfigParser.ConfigParser()
459         profileParser.add_section('profile')
460         profileParser.add_section('alterations')
461         global settingsList
462         for set in settingsList:
463                 if set.isPreference():
464                         continue
465                 if set.isAlteration():
466                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
467                 else:
468                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
469
470         profileParser.write(open(filename, 'w'))
471
472 def resetProfile():
473         #Read a configuration file as global config
474         global settingsList
475         for set in settingsList:
476                 if set.isPreference():
477                         continue
478                 set.setValue(set.getDefault())
479
480         if getPreference('machine_type') == 'ultimaker':
481                 putProfileSetting('nozzle_size', '0.4')
482                 if getPreference('ultimaker_extruder_upgrade') == 'True':
483                         putProfileSetting('retraction_enable', 'True')
484         else:
485                 putProfileSetting('nozzle_size', '0.5')
486
487 def loadProfileFromString(options):
488         options = base64.b64decode(options)
489         options = zlib.decompress(options)
490         (profileOpts, alt) = options.split('\f', 1)
491         global settingsDictionary
492         for option in profileOpts.split('\b'):
493                 if len(option) > 0:
494                         (key, value) = option.split('=', 1)
495                         if key in settingsDictionary:
496                                 if settingsDictionary[key].isProfile():
497                                         settingsDictionary[key].setValue(value)
498         for option in alt.split('\b'):
499                 if len(option) > 0:
500                         (key, value) = option.split('=', 1)
501                         if key in settingsDictionary:
502                                 if settingsDictionary[key].isAlteration():
503                                         settingsDictionary[key].setValue(value)
504
505 def getProfileString():
506         p = []
507         alt = []
508         global settingsList
509         for set in settingsList:
510                 if set.isProfile():
511                         if set.getName() in tempOverride:
512                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
513                         else:
514                                 p.append(set.getName() + "=" + set.getValue())
515                 if set.isAlteration():
516                         if set.getName() in tempOverride:
517                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
518                         else:
519                                 alt.append(set.getName() + "=" + set.getValue())
520         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
521         ret = base64.b64encode(zlib.compress(ret, 9))
522         return ret
523
524 def getGlobalPreferencesString():
525         p = []
526         global settingsList
527         for set in settingsList:
528                 if set.isPreference():
529                         p.append(set.getName() + "=" + set.getValue())
530         ret = '\b'.join(p)
531         ret = base64.b64encode(zlib.compress(ret, 9))
532         return ret
533
534
535 def getProfileSetting(name):
536         if name in tempOverride:
537                 return tempOverride[name]
538         global settingsDictionary
539         if name in settingsDictionary and settingsDictionary[name].isProfile():
540                 return settingsDictionary[name].getValue()
541         print 'Error: "%s" not found in profile settings' % (name)
542         return ''
543
544 def getProfileSettingFloat(name):
545         try:
546                 setting = getProfileSetting(name).replace(',', '.')
547                 return float(eval(setting, {}, {}))
548         except:
549                 return 0.0
550
551 def putProfileSetting(name, value):
552         #Check if we have a configuration file loaded, else load the default.
553         global settingsDictionary
554         if name in settingsDictionary and settingsDictionary[name].isProfile():
555                 settingsDictionary[name].setValue(value)
556
557 def isProfileSetting(name):
558         global settingsDictionary
559         if name in settingsDictionary and settingsDictionary[name].isProfile():
560                 return True
561         return False
562
563 ## Preferences functions
564 def getPreferencePath():
565         return os.path.join(getBasePath(), 'preferences.ini')
566
567 def getPreferenceFloat(name):
568         try:
569                 setting = getPreference(name).replace(',', '.')
570                 return float(eval(setting, {}, {}))
571         except:
572                 return 0.0
573
574 def getPreferenceColour(name):
575         colorString = getPreference(name)
576         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
577
578 def loadPreferences(filename):
579         #Read a configuration file as global config
580         profileParser = ConfigParser.ConfigParser()
581         try:
582                 profileParser.read(filename)
583         except ConfigParser.ParsingError:
584                 return
585         global settingsList
586         for set in settingsList:
587                 if set.isPreference():
588                         if profileParser.has_option('preference', set.getName()):
589                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
590
591 def savePreferences(filename):
592         #Save the current profile to an ini file
593         parser = ConfigParser.ConfigParser()
594         parser.add_section('preference')
595         global settingsList
596         for set in settingsList:
597                 if set.isPreference():
598                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
599         parser.write(open(filename, 'w'))
600
601 def getPreference(name):
602         if name in tempOverride:
603                 return tempOverride[name]
604         global settingsDictionary
605         if name in settingsDictionary and settingsDictionary[name].isPreference():
606                 return settingsDictionary[name].getValue()
607         print 'Error: "%s" not found in profile settings' % (name)
608         return ''
609
610 def putPreference(name, value):
611         #Check if we have a configuration file loaded, else load the default.
612         global settingsDictionary
613         if name in settingsDictionary and settingsDictionary[name].isPreference():
614                 settingsDictionary[name].setValue(value)
615         savePreferences(getPreferencePath())
616
617 def isPreference(name):
618         global settingsDictionary
619         if name in settingsDictionary and settingsDictionary[name].isPreference():
620                 return True
621         return False
622
623 ## Temp overrides for multi-extruder slicing and the project planner.
624 tempOverride = {}
625 def setTempOverride(name, value):
626         tempOverride[name] = unicode(value).encode("utf-8")
627 def clearTempOverride(name):
628         del tempOverride[name]
629 def resetTempOverride():
630         tempOverride.clear()
631
632 #########################################################
633 ## Utility functions to calculate common profile values
634 #########################################################
635 def calculateEdgeWidth():
636         wallThickness = getProfileSettingFloat('wall_thickness')
637         nozzleSize = getProfileSettingFloat('nozzle_size')
638
639         if wallThickness < 0.01:
640                 return nozzleSize
641         if wallThickness < nozzleSize:
642                 return wallThickness
643
644         lineCount = int(wallThickness / (nozzleSize - 0.0001))
645         if lineCount == 0:
646                 return nozzleSize
647         lineWidth = wallThickness / lineCount
648         lineWidthAlt = wallThickness / (lineCount + 1)
649         if lineWidth > nozzleSize * 1.5:
650                 return lineWidthAlt
651         return lineWidth
652
653 def calculateLineCount():
654         wallThickness = getProfileSettingFloat('wall_thickness')
655         nozzleSize = getProfileSettingFloat('nozzle_size')
656
657         if wallThickness < 0.01:
658                 return 0
659         if wallThickness < nozzleSize:
660                 return 1
661
662         lineCount = int(wallThickness / (nozzleSize - 0.0001))
663         if lineCount < 1:
664                 lineCount = 1
665         lineWidth = wallThickness / lineCount
666         lineWidthAlt = wallThickness / (lineCount + 1)
667         if lineWidth > nozzleSize * 1.5:
668                 return lineCount + 1
669         return lineCount
670
671 def calculateSolidLayerCount():
672         layerHeight = getProfileSettingFloat('layer_height')
673         solidThickness = getProfileSettingFloat('solid_layer_thickness')
674         if layerHeight == 0.0:
675                 return 1
676         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
677
678 def calculateObjectSizeOffsets():
679         size = 0.0
680
681         if getProfileSetting('platform_adhesion') == 'Brim':
682                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
683         elif getProfileSetting('platform_adhesion') == 'Raft':
684                 pass
685         else:
686                 if getProfileSettingFloat('skirt_line_count') > 0:
687                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
688
689         #if getProfileSetting('enable_raft') != 'False':
690         #       size += profile.getProfileSettingFloat('raft_margin') * 2
691         #if getProfileSetting('support') != 'None':
692         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
693         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
694         return [size, size]
695
696 def getMachineCenterCoords():
697         if getPreference('machine_center_is_zero') == 'True':
698                 return [0, 0]
699         return [getPreferenceFloat('machine_width') / 2, getPreferenceFloat('machine_depth') / 2]
700
701 #########################################################
702 ## Alteration file functions
703 #########################################################
704 def replaceTagMatch(m):
705         pre = m.group(1)
706         tag = m.group(2)
707         if tag == 'time':
708                 return pre + time.strftime('%H:%M:%S')
709         if tag == 'date':
710                 return pre + time.strftime('%d-%m-%Y')
711         if tag == 'day':
712                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
713         if tag == 'print_time':
714                 return pre + '#P_TIME#'
715         if tag == 'filament_amount':
716                 return pre + '#F_AMNT#'
717         if tag == 'filament_weight':
718                 return pre + '#F_WGHT#'
719         if tag == 'filament_cost':
720                 return pre + '#F_COST#'
721         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'max_z_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
722                 f = getProfileSettingFloat(tag) * 60
723         elif isProfileSetting(tag):
724                 f = getProfileSettingFloat(tag)
725         elif isPreference(tag):
726                 f = getProfileSettingFloat(tag)
727         else:
728                 return '%s?%s?' % (pre, tag)
729         if (f % 1) == 0:
730                 return pre + str(int(f))
731         return pre + str(f)
732
733 def replaceGCodeTags(filename, gcodeInt):
734         f = open(filename, 'r+')
735         data = f.read(2048)
736         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
737         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
738         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
739         cost = gcodeInt.calculateCost()
740         if cost is None:
741                 cost = 'Unknown'
742         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
743         f.seek(0)
744         f.write(data)
745         f.close()
746
747 ### Get aleration raw contents. (Used internally in Cura)
748 def getAlterationFile(filename):
749         if filename in tempOverride:
750                 return tempOverride[filename]
751         global settingsDictionary
752         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
753                 return settingsDictionary[filename].getValue()
754         print 'Error: "%s" not found in profile settings' % (filename)
755         return ''
756
757 def setAlterationFile(name, value):
758         #Check if we have a configuration file loaded, else load the default.
759         global settingsDictionary
760         if name in settingsDictionary and settingsDictionary[name].isAlteration():
761                 settingsDictionary[name].setValue(value)
762         saveProfile(getDefaultProfilePath())
763
764 ### Get the alteration file for output. (Used by Skeinforge)
765 def getAlterationFileContents(filename, extruderCount = 1):
766         prefix = ''
767         postfix = ''
768         alterationContents = getAlterationFile(filename)
769         if getPreference('gcode_flavor') == 'UltiGCode':
770                 return ''
771         if filename == 'start.gcode':
772                 if extruderCount > 1:
773                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
774                 #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.
775                 #We also set our steps per E here, if configured.
776                 eSteps = getPreferenceFloat('steps_per_e')
777                 if eSteps > 0:
778                         prefix += 'M92 E%f\n' % (eSteps)
779                 temp = getProfileSettingFloat('print_temperature')
780                 bedTemp = 0
781                 if getPreference('has_heated_bed') == 'True':
782                         bedTemp = getProfileSettingFloat('print_bed_temperature')
783
784                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
785                         prefix += 'M140 S%f\n' % (bedTemp)
786                 if temp > 0 and not '{print_temperature}' in alterationContents:
787                         if extruderCount > 0:
788                                 for n in xrange(1, extruderCount):
789                                         t = temp
790                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
791                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
792                                         prefix += 'M104 T%d S%f\n' % (n, t)
793                                 for n in xrange(0, extruderCount):
794                                         t = temp
795                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
796                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
797                                         prefix += 'M109 T%d S%f\n' % (n, t)
798                                 prefix += 'T0\n'
799                         else:
800                                 prefix += 'M109 S%f\n' % (temp)
801                 if bedTemp > 0 and not '{print_bed_temperature}' in alterationContents:
802                         prefix += 'M190 S%f\n' % (bedTemp)
803         elif filename == 'end.gcode':
804                 if extruderCount > 1:
805                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
806                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
807                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
808         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
809
810 ###### PLUGIN #####
811
812 def getPluginConfig():
813         try:
814                 return pickle.loads(str(getProfileSetting('plugin_config')))
815         except:
816                 return []
817
818 def setPluginConfig(config):
819         putProfileSetting('plugin_config', pickle.dumps(config))
820
821 def getPluginBasePaths():
822         ret = []
823         if platform.system() != "Windows":
824                 ret.append(os.path.expanduser('~/.cura/plugins/'))
825         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
826                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
827         else:
828                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
829         return ret
830
831 def getPluginList():
832         ret = []
833         for basePath in getPluginBasePaths():
834                 for filename in glob.glob(os.path.join(basePath, '*.py')):
835                         filename = os.path.basename(filename)
836                         if filename.startswith('_'):
837                                 continue
838                         with open(os.path.join(basePath, filename), "r") as f:
839                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
840                                 for line in f:
841                                         line = line.strip()
842                                         if not line.startswith('#'):
843                                                 break
844                                         line = line[1:].split(':', 1)
845                                         if len(line) != 2:
846                                                 continue
847                                         if line[0].upper() == 'NAME':
848                                                 item['name'] = line[1].strip()
849                                         elif line[0].upper() == 'INFO':
850                                                 item['info'] = line[1].strip()
851                                         elif line[0].upper() == 'TYPE':
852                                                 item['type'] = line[1].strip()
853                                         elif line[0].upper() == 'DEPEND':
854                                                 pass
855                                         elif line[0].upper() == 'PARAM':
856                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
857                                                 if m is not None:
858                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
859                                         else:
860                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
861                                 if item['name'] is not None and item['type'] == 'postprocess':
862                                         ret.append(item)
863         return ret
864
865 def runPostProcessingPlugins(gcodefilename):
866         pluginConfigList = getPluginConfig()
867         pluginList = getPluginList()
868
869         for pluginConfig in pluginConfigList:
870                 plugin = None
871                 for pluginTest in pluginList:
872                         if pluginTest['filename'] == pluginConfig['filename']:
873                                 plugin = pluginTest
874                 if plugin is None:
875                         continue
876
877                 pythonFile = None
878                 for basePath in getPluginBasePaths():
879                         testFilename = os.path.join(basePath, pluginConfig['filename'])
880                         if os.path.isfile(testFilename):
881                                 pythonFile = testFilename
882                 if pythonFile is None:
883                         continue
884
885                 locals = {'filename': gcodefilename}
886                 for param in plugin['params']:
887                         value = param['default']
888                         if param['name'] in pluginConfig['params']:
889                                 value = pluginConfig['params'][param['name']]
890
891                         if param['type'] == 'float':
892                                 try:
893                                         value = float(value)
894                                 except:
895                                         value = float(param['default'])
896
897                         locals[param['name']] = value
898                 try:
899                         execfile(pythonFile, locals)
900                 except:
901                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
902                         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])
903         return None