2 The profile module contains all the settings for Cura.
3 These settings can be globally accessed and modified.
5 from __future__ import division
6 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
21 import cPickle as pickle
23 if sys.version_info[0] < 3:
26 import configparser as ConfigParser
28 from Cura.util import version
29 from Cura.util import validators
31 #The settings dictionary contains a key/value reference to all possible settings. With the setting name as key.
32 settingsDictionary = {}
33 #The settings list is used to keep a full list of all the settings. This is needed to keep the settings in the proper order,
34 # as the dictionary will not contain insertion order.
37 #Currently selected machine (by index) Cura support multiple machines in the same preferences and can switch between them.
38 # Each machine has it's own index and unique name.
39 _selectedMachineIndex = 0
41 class setting(object):
43 A setting object contains a configuration setting. These are globally accessible trough the quick access functions
44 and trough the settingsDictionary function.
46 * profile settings (settings that effect the slicing process and the print result)
47 * preferences (settings that effect how cura works and acts)
48 * machine settings (settings that relate to the physical configuration of your machine)
49 * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
50 Settings have validators that check if the value is valid, but do not prevent invalid values!
51 Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
53 def __init__(self, name, default, type, category, subcategory):
57 self._default = unicode(default)
60 self._category = category
61 self._subcategory = subcategory
65 if type is types.FloatType:
66 validators.validFloat(self)
67 elif type is types.IntType:
68 validators.validInt(self)
70 global settingsDictionary
71 settingsDictionary[name] = self
73 settingsList.append(self)
75 def setLabel(self, label, tooltip = ''):
77 self._tooltip = tooltip
80 def setRange(self, minValue=None, maxValue=None):
81 if len(self._validators) < 1:
83 self._validators[0].minValue = minValue
84 self._validators[0].maxValue = maxValue
91 return _(self._tooltip)
93 def getCategory(self):
96 def getSubCategory(self):
97 return self._subcategory
99 def isPreference(self):
100 return self._category == 'preference'
102 def isMachineSetting(self):
103 return self._category == 'machine'
105 def isAlteration(self):
106 return self._category == 'alteration'
109 return not self.isAlteration() and not self.isPreference() and not self.isMachineSetting()
117 def getValue(self, index = None):
119 index = self.getValueIndex()
120 if index >= len(self._values):
122 return self._values[index]
124 def getDefault(self):
127 def setValue(self, value, index = None):
129 index = self.getValueIndex()
130 while index >= len(self._values):
131 self._values.append(self._default)
132 self._values[index] = unicode(value)
134 def getValueIndex(self):
135 if self.isMachineSetting() or self.isProfile() or self.isAlteration():
136 global _selectedMachineIndex
137 return _selectedMachineIndex
141 result = validators.SUCCESS
143 for validator in self._validators:
144 res, err = validator.validate()
145 if res == validators.ERROR:
147 elif res == validators.WARNING and result != validators.ERROR:
149 if res != validators.SUCCESS:
151 return result, '\n'.join(msgs)
153 def addCondition(self, conditionFunction):
154 self._conditions.append(conditionFunction)
156 def checkConditions(self):
157 for condition in self._conditions:
162 #########################################################
164 #########################################################
166 #Define a fake _() function to fake the gettext tools in to generating strings for the profile settings.
170 setting('layer_height', 0.1, float, 'basic', _('Quality')).setRange(0.0001).setLabel(_("Layer height (mm)"), _("Layer height in millimeters.\nThis is the most important setting to determine the quality of your print. Normal quality prints are 0.1mm, high quality is 0.06mm. You can go up to 0.25mm with an Ultimaker for very fast prints at low quality."))
171 setting('wall_thickness', 0.8, float, 'basic', _('Quality')).setRange(0.0).setLabel(_("Shell thickness (mm)"), _("Thickness of the outside shell in the horizontal direction.\nThis is used in combination with the nozzle size to define the number\nof perimeter lines and the thickness of those perimeter lines."))
172 setting('retraction_enable', True, bool, 'basic', _('Quality')).setLabel(_("Enable retraction"), _("Retract the filament when the nozzle is moving over a none-printed area. Details about the retraction can be configured in the advanced tab."))
173 setting('solid_layer_thickness', 0.6, float, 'basic', _('Fill')).setRange(0).setLabel(_("Bottom/Top thickness (mm)"), _("This controls the thickness of the bottom and top layers, the amount of solid layers put down is calculated by the layer thickness and this value.\nHaving this value a multiple of the layer thickness makes sense. And keep it near your wall thickness to make an evenly strong part."))
174 setting('fill_density', 20, float, 'basic', _('Fill')).setRange(0, 100).setLabel(_("Fill Density (%)"), _("This controls how densely filled the insides of your print will be. For a solid part use 100%, for an empty part use 0%. A value around 20% is usually enough.\nThis won't affect the outside of the print and only adjusts how strong the part becomes."))
175 setting('nozzle_size', 0.4, float, 'advanced', _('Machine')).setRange(0.1,10).setLabel(_("Nozzle size (mm)"), _("The nozzle size is very important, this is used to calculate the line width of the infill, and used to calculate the amount of outside wall lines and thickness for the wall thickness you entered in the print settings."))
176 setting('print_speed', 50, float, 'basic', _('Speed and Temperature')).setRange(1).setLabel(_("Print speed (mm/s)"), _("Speed at which printing happens. A well adjusted Ultimaker can reach 150mm/s, but for good quality prints you want to print slower. Printing speed depends on a lot of factors. So you will be experimenting with optimal settings for this."))
177 setting('print_temperature', 220, int, 'basic', _('Speed and Temperature')).setRange(0,340).setLabel(_("Printing temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
178 setting('print_temperature2', 0, int, 'basic', _('Speed and Temperature')).setRange(0,340).setLabel(_("2nd nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
179 setting('print_temperature3', 0, int, 'basic', _('Speed and Temperature')).setRange(0,340).setLabel(_("3th nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
180 setting('print_temperature4', 0, int, 'basic', _('Speed and Temperature')).setRange(0,340).setLabel(_("4th nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
181 setting('print_bed_temperature', 70, int, 'basic', _('Speed and Temperature')).setRange(0,340).setLabel(_("Bed temperature (C)"), _("Temperature used for the heated printer bed. Set at 0 to pre-heat yourself."))
182 setting('support', 'None', [_('None'), _('Touching buildplate'), _('Everywhere')], 'basic', _('Support')).setLabel(_("Support type"), _("Type of support structure build.\n\"Touching buildplate\" is the most commonly used support setting.\n\nNone does not do any support.\nTouching buildplate only creates support where the support structure will touch the build platform.\nEverywhere creates support even on top of parts of the model."))
183 setting('platform_adhesion', 'None', [_('None'), _('Brim'), _('Raft')], 'basic', _('Support')).setLabel(_("Platform adhesion type"), _("Different options that help in preventing corners from lifting due to warping.\nBrim adds a single layer thick flat area around your object which is easy to cut off afterwards, and it is the recommended option.\nRaft adds a thick raster below the object and a thin interface between this and your object.\n(Note that enabling the brim or raft disables the skirt)"))
184 setting('support_dual_extrusion', 'Both', [_('Both'), _('First extruder'), _('Second extruder')], 'basic', _('Support')).setLabel(_("Support dual extrusion"), _("Which extruder to use for support material, for break-away support you can use both extruders.\nBut if one of the materials is more expensive then the other you could select an extruder to use for support material. This causes more extruder switches.\nYou can also use the 2nd extruder for soluble support materials."))
185 setting('wipe_tower', False, bool, 'basic', _('Dual extrusion')).setLabel(_("Wipe&prime tower"), _("The wipe-tower is a tower printed on every layer when switching between nozzles.\nThe old nozzle is wiped off on the tower before the new nozzle is used to print the 2nd color."))
186 setting('wipe_tower_volume', 15, float, 'expert', _('Dual extrusion')).setLabel(_("Wipe&prime tower volume per layer (mm3)"), _("The amount of material put in the wipe/prime tower.\nThis is done in volume because in general you want to extrude a\ncertain amount of volume to get the extruder going, independent on the layer height.\nThis means that with thinner layers, your tower gets bigger."))
187 setting('ooze_shield', False, bool, 'basic', _('Dual extrusion')).setLabel(_("Ooze shield"), _("The ooze shield is a 1 line thick shell around the object which stands a few mm from the object.\nThis shield catches any oozing from the unused nozzle in dual-extrusion."))
188 setting('filament_diameter', 2.85, float, 'basic', _('Filament')).setRange(1).setLabel(_("Diameter (mm)"), _("Diameter of your filament, as accurately as possible.\nIf you cannot measure this value you will have to calibrate it, a higher number means less extrusion, a smaller number generates more extrusion."))
189 setting('filament_diameter2', 0, float, 'basic', _('Filament')).setRange(0).setLabel(_("Diameter2 (mm)"), _("Diameter of your filament for the 2nd nozzle. Use 0 to use the same diameter as for nozzle 1."))
190 setting('filament_diameter3', 0, float, 'basic', _('Filament')).setRange(0).setLabel(_("Diameter3 (mm)"), _("Diameter of your filament for the 3th nozzle. Use 0 to use the same diameter as for nozzle 1."))
191 setting('filament_diameter4', 0, float, 'basic', _('Filament')).setRange(0).setLabel(_("Diameter4 (mm)"), _("Diameter of your filament for the 4th nozzle. Use 0 to use the same diameter as for nozzle 1."))
192 setting('filament_flow', 100., float, 'basic', _('Filament')).setRange(5,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
193 setting('retraction_speed', 40.0, float, 'advanced', _('Retraction')).setRange(0.1).setLabel(_("Speed (mm/s)"), _("Speed at which the filament is retracted, a higher retraction speed works better. But a very high retraction speed can lead to filament grinding."))
194 setting('retraction_amount', 4.5, float, 'advanced', _('Retraction')).setRange(0).setLabel(_("Distance (mm)"), _("Amount of retraction, set at 0 for no retraction at all. A value of 4.5mm seems to generate good results."))
195 setting('retraction_dual_amount', 16.5, float, 'advanced', _('Retraction')).setRange(0).setLabel(_("Dual extrusion switch amount (mm)"), _("Amount of retraction when switching nozzle with dual-extrusion, set at 0 for no retraction at all. A value of 16.0mm seems to generate good results."))
196 setting('retraction_min_travel', 1.5, float, 'expert', _('Retraction')).setRange(0).setLabel(_("Minimum travel (mm)"), _("Minimum amount of travel needed for a retraction to happen at all. To make sure you do not get a lot of retractions in a small area."))
197 setting('retraction_combing', True, bool, 'expert', _('Retraction')).setLabel(_("Enable combing"), _("Combing is the act of avoiding holes in the print for the head to travel over. If combing is disabled the printer head moves straight from the start point to the end point and it will always retract."))
198 setting('retraction_minimal_extrusion',0.02, float,'expert', _('Retraction')).setRange(0).setLabel(_("Minimal extrusion before retracting (mm)"), _("The minimal amount of extrusion that needs to be done before retracting again if a retraction needs to happen before this minimal is reached the retraction is ignored.\nThis avoids retracting a lot on the same piece of filament which flattens the filament and causes grinding issues."))
199 setting('retraction_hop', 0.0, float, 'expert', _('Retraction')).setRange(0).setLabel(_("Z hop when retracting (mm)"), _("When a retraction is done, the head is lifted by this amount to travel over the print. A value of 0.075 works well. This feature has a lot of positive effect on delta towers."))
200 setting('bottom_thickness', 0.3, float, 'advanced', _('Quality')).setRange(0).setLabel(_("Initial layer thickness (mm)"), _("Layer thickness of the bottom layer. A thicker bottom layer makes sticking to the bed easier. Set to 0.0 to have the bottom layer thickness the same as the other layers."))
201 setting('object_sink', 0.0, float, 'advanced', _('Quality')).setRange(0).setLabel(_("Cut off object bottom (mm)"), _("Sinks the object into the platform, this can be used for objects that do not have a flat bottom and thus create a too small first layer."))
202 #setting('enable_skin', False, bool, 'advanced', _('Quality')).setLabel(_("Duplicate outlines"), _("Skin prints the outer lines of the prints twice, each time with half the thickness. This gives the illusion of a higher print quality."))
203 setting('overlap_dual', 0.15, float, 'advanced', _('Quality')).setLabel(_("Dual extrusion overlap (mm)"), _("Add a certain amount of overlapping extrusion on dual-extrusion prints. This bonds the different colors together."))
204 setting('travel_speed', 150.0, float, 'advanced', _('Speed')).setRange(0.1).setLabel(_("Travel speed (mm/s)"), _("Speed at which travel moves are done, a well built Ultimaker can reach speeds of 250mm/s. But some machines might miss steps then."))
205 setting('bottom_layer_speed', 20, float, 'advanced', _('Speed')).setRange(0.1).setLabel(_("Bottom layer speed (mm/s)"), _("Print speed for the bottom layer, you want to print the first layer slower so it sticks better to the printer bed."))
206 setting('infill_speed', 0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Infill speed (mm/s)"), _("Speed at which infill parts are printed. If set to 0 then the print speed is used for the infill. Printing the infill faster can greatly reduce printing time, but this can negatively affect print quality."))
207 setting('inset0_speed', 0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Outer shell speed (mm/s)"), _("Speed at which outer shell is printed. If set to 0 then the print speed is used. Printing the outer shell at a lower speed improves the final skin quality. However, having a large difference between the inner shell speed and the outer shell speed will effect quality in a negative way."))
208 setting('insetx_speed', 0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Inner shell speed (mm/s)"), _("Speed at which inner shells are printed. If set to 0 then the print speed is used. Printing the inner shell faster then the outer shell will reduce printing time. It is good to set this somewhere in between the outer shell speed and the infill/printing speed."))
209 setting('cool_min_layer_time', 5, float, 'advanced', _('Cool')).setRange(0).setLabel(_("Minimal layer time (sec)"), _("Minimum time spent 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 spent at least this amount of seconds printing this layer."))
210 setting('fan_enabled', True, bool, 'advanced', _('Cool')).setLabel(_("Enable cooling fan"), _("Enable the cooling fan during the print. The extra cooling from the cooling fan is essential during faster prints."))
212 setting('skirt_line_count', 1, int, 'expert', 'Skirt').setRange(0).setLabel(_("Line count"), _("The skirt is a line drawn around the object at the first layer. This helps to prime your extruder, and to see if the object fits on your platform.\nSetting this to 0 will disable the skirt. Multiple skirt lines can help priming your extruder better for small objects."))
213 setting('skirt_gap', 3.0, float, 'expert', 'Skirt').setRange(0).setLabel(_("Start distance (mm)"), _("The distance between the skirt and the first layer.\nThis is the minimal distance, multiple skirt lines will be put outwards from this distance."))
214 setting('skirt_minimal_length', 150.0, float, 'expert', 'Skirt').setRange(0).setLabel(_("Minimal length (mm)"), _("The minimal length of the skirt, if this minimal length is not reached it will add more skirt lines to reach this minimal lenght.\nNote: If the line count is set to 0 this is ignored."))
215 setting('fan_full_height', 0.5, float, 'expert', _('Cool')).setRange(0).setLabel(_("Fan full on at height (mm)"), _("The height at which the fan is turned on completely. For the layers below this the fan speed is scaled linearly with the fan off at layer 0."))
216 setting('fan_speed', 100, int, 'expert', _('Cool')).setRange(0,100).setLabel(_("Fan speed min (%)"), _("When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Minimal fan speed is used if the layer is not slowed down due to cooling."))
217 setting('fan_speed_max', 100, int, 'expert', _('Cool')).setRange(0,100).setLabel(_("Fan speed max (%)"), _("When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Maximal fan speed is used if the layer is slowed down due to cooling by more than 200%."))
218 setting('cool_min_feedrate', 10, float, 'expert', _('Cool')).setRange(0).setLabel(_("Minimum speed (mm/s)"), _("The minimal layer time can cause the print to slow down so much it starts to ooze. The minimal feedrate protects against this. Even if a print gets slowed down it will never be slower than this minimal speed."))
219 setting('cool_head_lift', False, bool, 'expert', _('Cool')).setLabel(_("Cool head lift"), _("Lift the head if the minimal speed is hit because of cool slowdown, and wait the extra time so the minimal layer time is always hit."))
220 setting('solid_top', True, bool, 'expert', _('Infill')).setLabel(_("Solid infill top"), _("Create a solid top surface, if set to false the top is filled with the fill percentage. Useful for cups/vases."))
221 setting('solid_bottom', True, bool, 'expert', _('Infill')).setLabel(_("Solid infill bottom"), _("Create a solid bottom surface, if set to false the bottom is filled with the fill percentage. Useful for buildings."))
222 setting('fill_overlap', 15, int, 'expert', _('Infill')).setRange(0,100).setLabel(_("Infill overlap (%)"), _("Amount of overlap between the infill and the walls. There is a slight overlap with the walls and the infill so the walls connect firmly to the infill."))
223 setting('support_type', 'Grid', ['Grid', 'Lines'], 'expert', _('Support')).setLabel(_("Structure type"), _("The type of support structure.\nGrid is very strong and can come off in 1 piece, however, sometimes it is too strong.\nLines are single walled lines that break off one at a time. Which is more work to remove, but as it is less strong it does work better on tricky prints."))
224 setting('support_angle', 60, float, 'expert', _('Support')).setRange(0,90).setLabel(_("Overhang angle for support (deg)"), _("The minimal angle that overhangs need to have to get support. With 0 degree being horizontal and 90 degree being vertical."))
225 setting('support_fill_rate', 15, int, 'expert', _('Support')).setRange(0,100).setLabel(_("Fill amount (%)"), _("Amount of infill structure in the support material, less material gives weaker support which is easier to remove. 15% seems to be a good average."))
226 setting('support_xy_distance', 0.7, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance X/Y (mm)"), _("Distance of the support material from the print, in the X/Y directions.\n0.7mm gives a nice distance from the print so the support does not stick to the print."))
227 setting('support_z_distance', 0.15, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance Z (mm)"), _("Distance from the top/bottom of the support to the print. A small gap here makes it easier to remove the support but makes the print a bit uglier.\n0.15mm gives a good seperation of the support material."))
228 setting('spiralize', False, bool, 'expert', 'Spiralize').setLabel(_("Spiralize the outer contour"), _("Spiralize is smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. This feature turns a solid object into a single walled print with a solid bottom."))
229 #setting('bridge_speed', 100, int, 'expert', 'Bridge').setRange(0,100).setLabel(_("Bridge speed (%)"), _("Speed at which layers with bridges are printed, compared to normal printing speed."))
230 setting('brim_line_count', 20, int, 'expert', _('Brim')).setRange(1,100).setLabel(_("Brim line amount"), _("The amount of lines used for a brim, more lines means a larger brim which sticks better, but this also makes your effective print area smaller."))
231 setting('raft_margin', 5, float, 'expert', _('Raft')).setRange(0).setLabel(_("Extra margin (mm)"), _("If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft while using more material and leaving less area for your print."))
232 setting('raft_line_spacing', 1.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Line spacing (mm)"), _("When you are using the raft this is the distance between the centerlines of the raft line."))
233 setting('raft_base_thickness', 0.3, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base thickness (mm)"), _("When you are using the raft this is the thickness of the base layer which is put down."))
234 setting('raft_base_linewidth', 0.7, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base line width (mm)"), _("When you are using the raft this is the width of the base layer lines which are put down."))
235 setting('raft_interface_thickness', 0.2, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface thickness (mm)"), _("When you are using the raft this is the thickness of the interface layer which is put down."))
236 setting('raft_interface_linewidth', 0.2, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface line width (mm)"), _("When you are using the raft this is the width of the interface layer lines which are put down."))
237 setting('raft_airgap', 0.2, float, 'expert', _('Raft')).setRange(0).setLabel(_("Airgap"), _("Gap between the last layer of the raft and the first printing layer. A small gap of 0.2mm works wonders on PLA and makes the raft easy to remove."))
238 setting('raft_surface_layers', 2, int, 'expert', _('Raft')).setRange(0).setLabel(_("Surface layers"), _("Amount of surface layers put on top of the raft, these are fully filled layers on which the model is printed."))
239 setting('fix_horrible_union_all_type_a', True, bool, 'expert', _('Fix horrible')).setLabel(_("Combine everything (Type-A)"), _("This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is dependent 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."))
240 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 dependent 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."))
241 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 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."))
242 setting('fix_horrible_extensive_stitching', False, bool, 'expert', _('Fix horrible')).setLabel(_("Extensive stitching"), _("Extensive 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."))
244 setting('plugin_config', '', str, 'hidden', 'hidden')
245 setting('object_center_x', -1, float, 'hidden', 'hidden')
246 setting('object_center_y', -1, float, 'hidden', 'hidden')
248 setting('start.gcode', """;Sliced at: {day} {date} {time}
249 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
250 ;Print time: {print_time}
251 ;Filament used: {filament_amount}m {filament_weight}g
252 ;Filament cost: {filament_cost}
253 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
254 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
256 G90 ;absolute positioning
257 M82 ;set extruder to absolute mode
258 M107 ;start with the fan off
260 G28 X0 Y0 ;move X/Y to min endstops
261 G28 Z0 ;move Z to min endstops
263 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
265 G92 E0 ;zero the extruded length
266 G1 F200 E3 ;extrude 3mm of feed stock
267 G92 E0 ;zero the extruded length again
269 ;Put printing message on LCD screen
271 """, str, 'alteration', 'alteration')
272 #######################################################################################
273 setting('end.gcode', """;End GCode
274 M104 S0 ;extruder heater off
275 M140 S0 ;heated bed heater off (if you have it)
277 G91 ;relative positioning
278 G1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure
279 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
280 G28 X0 Y0 ;move X/Y to min endstops, so the head is out of the way
283 G90 ;absolute positioning
285 """, str, 'alteration', 'alteration')
286 #######################################################################################
287 setting('start2.gcode', """;Sliced at: {day} {date} {time}
288 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
289 ;Print time: {print_time}
290 ;Filament used: {filament_amount}m {filament_weight}g
291 ;Filament cost: {filament_cost}
292 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
293 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
294 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
295 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
297 G90 ;absolute positioning
298 M107 ;start with the fan off
300 G28 X0 Y0 ;move X/Y to min endstops
301 G28 Z0 ;move Z to min endstops
303 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
305 T1 ;Switch to the 2nd extruder
306 G92 E0 ;zero the extruded length
307 G1 F200 E10 ;extrude 10mm of feed stock
308 G92 E0 ;zero the extruded length again
309 G1 F200 E-{retraction_dual_amount}
311 T0 ;Switch to the first extruder
312 G92 E0 ;zero the extruded length
313 G1 F200 E10 ;extrude 10mm of feed stock
314 G92 E0 ;zero the extruded length again
316 ;Put printing message on LCD screen
318 """, str, 'alteration', 'alteration')
319 #######################################################################################
320 setting('end2.gcode', """;End GCode
321 M104 T0 S0 ;extruder heater off
322 M104 T1 S0 ;extruder heater off
323 M140 S0 ;heated bed heater off (if you have it)
325 G91 ;relative positioning
326 G1 E-1 F300 ;retract the filament a bit before lifting the nozzle, to release some of the pressure
327 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
328 G28 X0 Y0 ;move X/Y to min endstops, so the head is out of the way
331 G90 ;absolute positioning
333 """, str, 'alteration', 'alteration')
334 #######################################################################################
335 setting('support_start.gcode', '', str, 'alteration', 'alteration')
336 setting('support_end.gcode', '', str, 'alteration', 'alteration')
337 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
338 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
339 setting('replace.csv', '', str, 'alteration', 'alteration')
340 #######################################################################################
341 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
346 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
349 """, str, 'alteration', 'alteration')
351 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
352 setting('oneAtATime', 'True', bool, 'preference', 'hidden')
353 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
354 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."))
355 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."))
356 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."))
357 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."))
358 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
359 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve future versions of Cura"))
360 setting('youmagine_token', '', str, 'preference', 'hidden')
361 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."))
362 setting('language', 'English', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
363 setting('active_machine', '0', int, 'preference', 'hidden')
365 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel(_('Model colour'), _('Display color for first extruder'))
366 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'), _('Display color for second extruder'))
367 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'), _('Display color for third extruder'))
368 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'), _('Display color for forth extruder'))
369 setting('printing_window', 'Basic', ['Basic'], 'preference', 'hidden').setLabel(_('Printing window type'), _('Select the interface used for USB printing.'))
371 setting('window_maximized', 'True', bool, 'preference', 'hidden')
372 setting('window_pos_x', '-1', float, 'preference', 'hidden')
373 setting('window_pos_y', '-1', float, 'preference', 'hidden')
374 setting('window_width', '-1', float, 'preference', 'hidden')
375 setting('window_height', '-1', float, 'preference', 'hidden')
376 setting('window_normal_sash', '320', float, 'preference', 'hidden')
377 setting('last_run_version', '', str, 'preference', 'hidden')
379 setting('machine_name', '', str, 'machine', 'hidden')
380 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
381 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Size of the machine in mm"))
382 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
383 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine in mm"))
384 setting('machine_center_is_zero', 'False', bool, 'machine', 'hidden').setLabel(_("Machine center 0,0"), _("Machines firmware defines the center of the bed as 0,0 instead of the front left corner."))
385 setting('machine_shape', 'Square', ['Square','Circular'], 'machine', 'hidden').setLabel(_("Build area shape"), _("The shape of machine build area."))
386 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
387 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have an heated bed, this enabled heated bed settings (requires restart)"))
388 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'RepRap (Volumetric)', 'UltiGCode', 'MakerBot', 'BFB', 'Mach3'], 'machine', 'hidden').setLabel(_("GCode Flavor"), _("Flavor of generated GCode.\nRepRap is normal 5D GCode which works on Marlin/Sprinter based firmwares.\nUltiGCode is a variation of the RepRap GCode which puts more settings in the machine instead of the slicer.\nMakerBot GCode has a few changes in the way GCode is generated, but still requires MakerWare to generate to X3G.\nBFB style generates RPM based code.\nMach3 uses A,B,C instead of E for extruders."))
389 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
390 setting('extruder_offset_x1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
391 setting('extruder_offset_y1', '21.6', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
392 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
393 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
394 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
395 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
396 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."))
397 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
398 setting('serial_port_auto', '', str, 'machine', 'hidden')
399 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"))
400 setting('serial_baud_auto', '', int, 'machine', 'hidden')
402 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."))
403 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."))
404 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."))
405 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."))
406 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."))
408 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
409 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
410 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."))
411 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
412 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
413 validators.printSpeedValidator(settingsDictionary['print_speed'])
414 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
415 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
416 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
417 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
418 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
419 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
420 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
421 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
422 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
423 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."))
425 #Conditions for multiple extruders
426 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
427 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
428 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
429 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
430 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
431 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
432 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
433 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
434 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
435 settingsDictionary['wipe_tower_volume'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
436 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
438 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
440 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
441 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
442 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
443 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
444 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
445 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
446 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
447 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
448 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
449 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
450 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
451 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
452 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
453 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
455 #Remove fake defined _() because later the localization will define a global _()
458 #########################################################
459 ## Profile and preferences functions
460 #########################################################
462 def getSubCategoriesFor(category):
465 for s in settingsList:
466 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
467 done[s.getSubCategory()] = True
468 ret.append(s.getSubCategory())
471 def getSettingsForCategory(category, subCategory = None):
473 for s in settingsList:
474 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
481 :return: The path in which the current configuration files are stored. This depends on the used OS.
483 if platform.system() == "Windows":
484 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
485 #If we have a frozen python install, we need to step out of the library.zip
486 if hasattr(sys, 'frozen'):
487 basePath = os.path.normpath(os.path.join(basePath, ".."))
489 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
490 if not os.path.isdir(basePath):
492 os.makedirs(basePath)
494 print "Failed to create directory: %s" % (basePath)
497 def getAlternativeBasePaths():
499 Search for alternative installations of Cura and their preference files. Used to load configuration from older versions of Cura.
502 basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
503 for subPath in os.listdir(basePath):
504 path = os.path.join(basePath, subPath)
505 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
507 path = os.path.join(basePath, subPath, 'Cura')
508 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
512 def getDefaultProfilePath():
514 :return: The default path where the currently used profile is stored and loaded on open and close of Cura.
516 return os.path.join(getBasePath(), 'current_profile.ini')
518 def loadProfile(filename, allMachines = False):
520 Read a profile file as active profile settings.
521 :param filename: The ini filename to save the profile in.
522 :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
525 profileParser = ConfigParser.ConfigParser()
527 profileParser.read(filename)
528 except ConfigParser.ParsingError:
532 while profileParser.has_section('profile_%d' % (n)):
533 for set in settingsList:
534 if set.isPreference():
536 section = 'profile_%d' % (n)
537 if set.isAlteration():
538 section = 'alterations_%d' % (n)
539 if profileParser.has_option(section, set.getName()):
540 set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'), n)
543 for set in settingsList:
544 if set.isPreference():
547 if set.isAlteration():
548 section = 'alterations'
549 if profileParser.has_option(section, set.getName()):
550 set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
552 def saveProfile(filename, allMachines = False):
554 Save the current profile to an ini file.
555 :param filename: The ini filename to save the profile in.
556 :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
559 profileParser = ConfigParser.ConfigParser()
561 for set in settingsList:
562 if set.isPreference() or set.isMachineSetting():
564 for n in xrange(0, getMachineCount()):
565 if set.isAlteration():
566 section = 'alterations_%d' % (n)
568 section = 'profile_%d' % (n)
569 if not profileParser.has_section(section):
570 profileParser.add_section(section)
571 profileParser.set(section, set.getName(), set.getValue(n).encode('utf-8'))
573 profileParser.add_section('profile')
574 profileParser.add_section('alterations')
575 for set in settingsList:
576 if set.isPreference() or set.isMachineSetting():
578 if set.isAlteration():
579 profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
581 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
583 profileParser.write(open(filename, 'w'))
586 """ Reset the profile for the current machine to default. """
588 for set in settingsList:
589 if not set.isProfile():
591 set.setValue(set.getDefault())
593 if getMachineSetting('machine_type') == 'ultimaker':
594 putProfileSetting('nozzle_size', '0.4')
595 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
596 putProfileSetting('retraction_enable', 'True')
597 elif getMachineSetting('machine_type') == 'ultimaker2':
598 putProfileSetting('nozzle_size', '0.4')
599 putProfileSetting('retraction_enable', 'True')
601 putProfileSetting('nozzle_size', '0.5')
602 putProfileSetting('retraction_enable', 'True')
604 def setProfileFromString(options):
606 Parse an encoded string which has all the profile settings stored inside of it.
607 Used in combination with getProfileString to ease sharing of profiles.
609 options = base64.b64decode(options)
610 options = zlib.decompress(options)
611 (profileOpts, alt) = options.split('\f', 1)
612 global settingsDictionary
613 for option in profileOpts.split('\b'):
615 (key, value) = option.split('=', 1)
616 if key in settingsDictionary:
617 if settingsDictionary[key].isProfile():
618 settingsDictionary[key].setValue(value)
619 for option in alt.split('\b'):
621 (key, value) = option.split('=', 1)
622 if key in settingsDictionary:
623 if settingsDictionary[key].isAlteration():
624 settingsDictionary[key].setValue(value)
626 def getProfileString():
628 Get an encoded string which contains all profile settings.
629 Used in combination with setProfileFromString to share settings in files, forums or other text based ways.
634 for set in settingsList:
636 if set.getName() in tempOverride:
637 p.append(set.getName() + "=" + tempOverride[set.getName()])
639 p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
640 elif set.isAlteration():
641 if set.getName() in tempOverride:
642 alt.append(set.getName() + "=" + tempOverride[set.getName()])
644 alt.append(set.getName() + "=" + set.getValue().encode('utf-8'))
645 ret = '\b'.join(p) + '\f' + '\b'.join(alt)
646 ret = base64.b64encode(zlib.compress(ret, 9))
649 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
651 for i in xrange(0, len(string), every):
652 lines.append(string[i:i+every])
653 return '\n'.join(lines)
655 def getPreferencesString():
657 :return: An encoded string which contains all the current preferences.
661 for set in settingsList:
662 if set.isPreference():
663 p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
665 ret = base64.b64encode(zlib.compress(ret, 9))
669 def getProfileSetting(name):
671 Get the value of an profile setting.
672 :param name: Name of the setting to retrieve.
673 :return: Value of the current setting.
675 if name in tempOverride:
676 return tempOverride[name]
677 global settingsDictionary
678 if name in settingsDictionary and settingsDictionary[name].isProfile():
679 return settingsDictionary[name].getValue()
680 traceback.print_stack()
681 sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
684 def getProfileSettingFloat(name):
686 setting = getProfileSetting(name).replace(',', '.')
687 return float(eval(setting, {}, {}))
691 def putProfileSetting(name, value):
692 """ Store a certain value in a profile setting. """
693 global settingsDictionary
694 if name in settingsDictionary and settingsDictionary[name].isProfile():
695 settingsDictionary[name].setValue(value)
697 def isProfileSetting(name):
698 """ Check if a certain key name is actually a profile value. """
699 global settingsDictionary
700 if name in settingsDictionary and settingsDictionary[name].isProfile():
704 ## Preferences functions
705 def getPreferencePath():
707 :return: The full path of the preference ini file.
709 return os.path.join(getBasePath(), 'preferences.ini')
711 def getPreferenceFloat(name):
713 Get the float value of a preference, returns 0.0 if the preference is not a invalid float
716 setting = getPreference(name).replace(',', '.')
717 return float(eval(setting, {}, {}))
721 def getPreferenceColour(name):
723 Get a preference setting value as a color array. The color is stored as #RRGGBB hex string in the setting.
725 colorString = getPreference(name)
726 return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
728 def loadPreferences(filename):
730 Read a configuration file as global config
733 profileParser = ConfigParser.ConfigParser()
735 profileParser.read(filename)
736 except ConfigParser.ParsingError:
739 for set in settingsList:
740 if set.isPreference():
741 if profileParser.has_option('preference', set.getName()):
742 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
745 while profileParser.has_section('machine_%d' % (n)):
746 for set in settingsList:
747 if set.isMachineSetting():
748 if profileParser.has_option('machine_%d' % (n), set.getName()):
749 set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
752 setActiveMachine(int(getPreferenceFloat('active_machine')))
754 def loadMachineSettings(filename):
756 #Read a configuration file as global config
757 profileParser = ConfigParser.ConfigParser()
759 profileParser.read(filename)
760 except ConfigParser.ParsingError:
763 for set in settingsList:
764 if set.isMachineSetting():
765 if profileParser.has_option('machine', set.getName()):
766 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
767 checkAndUpdateMachineName()
769 def savePreferences(filename):
771 #Save the current profile to an ini file
772 parser = ConfigParser.ConfigParser()
773 parser.add_section('preference')
775 for set in settingsList:
776 if set.isPreference():
777 parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
780 while getMachineSetting('machine_name', n) != '':
781 parser.add_section('machine_%d' % (n))
782 for set in settingsList:
783 if set.isMachineSetting():
784 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
786 parser.write(open(filename, 'w'))
788 def getPreference(name):
789 if name in tempOverride:
790 return tempOverride[name]
791 global settingsDictionary
792 if name in settingsDictionary and settingsDictionary[name].isPreference():
793 return settingsDictionary[name].getValue()
794 traceback.print_stack()
795 sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
798 def putPreference(name, value):
799 #Check if we have a configuration file loaded, else load the default.
800 global settingsDictionary
801 if name in settingsDictionary and settingsDictionary[name].isPreference():
802 settingsDictionary[name].setValue(value)
803 savePreferences(getPreferencePath())
805 traceback.print_stack()
806 sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
808 def isPreference(name):
809 global settingsDictionary
810 if name in settingsDictionary and settingsDictionary[name].isPreference():
814 def getMachineSettingFloat(name, index = None):
816 setting = getMachineSetting(name, index).replace(',', '.')
817 return float(eval(setting, {}, {}))
821 def getMachineSetting(name, index = None):
822 if name in tempOverride:
823 return tempOverride[name]
824 global settingsDictionary
825 if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
826 return settingsDictionary[name].getValue(index)
827 traceback.print_stack()
828 sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
831 def putMachineSetting(name, value):
832 #Check if we have a configuration file loaded, else load the default.
833 global settingsDictionary
834 if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
835 settingsDictionary[name].setValue(value)
836 savePreferences(getPreferencePath())
838 def isMachineSetting(name):
839 global settingsDictionary
840 if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
844 def checkAndUpdateMachineName():
845 global _selectedMachineIndex
846 name = getMachineSetting('machine_name')
849 name = getMachineSetting('machine_type')
850 for n in xrange(0, getMachineCount()):
851 if n == _selectedMachineIndex:
854 if name == getMachineSetting('machine_name', n):
857 if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
859 if index is not None:
860 name = '%s (%d)' % (name, index)
861 putMachineSetting('machine_name', name)
862 putPreference('active_machine', _selectedMachineIndex)
864 def getMachineCount():
866 while getMachineSetting('machine_name', n) != '':
872 def setActiveMachine(index):
873 global _selectedMachineIndex
874 _selectedMachineIndex = index
875 putPreference('active_machine', _selectedMachineIndex)
877 def removeMachine(index):
878 global _selectedMachineIndex
880 if getMachineCount() < 2:
882 for n in xrange(index, getMachineCount()):
883 for setting in settingsList:
884 if setting.isMachineSetting():
885 setting.setValue(setting.getValue(n+1), n)
887 if _selectedMachineIndex >= index:
888 setActiveMachine(getMachineCount() - 1)
890 ## Temp overrides for multi-extruder slicing and the project planner.
892 def setTempOverride(name, value):
893 tempOverride[name] = unicode(value).encode("utf-8")
894 def clearTempOverride(name):
895 del tempOverride[name]
896 def resetTempOverride():
899 #########################################################
900 ## Utility functions to calculate common profile values
901 #########################################################
902 def calculateEdgeWidth():
903 wallThickness = getProfileSettingFloat('wall_thickness')
904 nozzleSize = getProfileSettingFloat('nozzle_size')
906 if getProfileSetting('spiralize') == 'True':
909 if wallThickness < 0.01:
911 if wallThickness < nozzleSize:
914 lineCount = int(wallThickness / (nozzleSize - 0.0001))
917 lineWidth = wallThickness / lineCount
918 lineWidthAlt = wallThickness / (lineCount + 1)
919 if lineWidth > nozzleSize * 1.5:
923 def calculateLineCount():
924 wallThickness = getProfileSettingFloat('wall_thickness')
925 nozzleSize = getProfileSettingFloat('nozzle_size')
927 if wallThickness < 0.01:
929 if wallThickness < nozzleSize:
931 if getProfileSetting('spiralize') == 'True':
934 lineCount = int(wallThickness / (nozzleSize - 0.0001))
937 lineWidth = wallThickness / lineCount
938 lineWidthAlt = wallThickness / (lineCount + 1)
939 if lineWidth > nozzleSize * 1.5:
943 def calculateSolidLayerCount():
944 layerHeight = getProfileSettingFloat('layer_height')
945 solidThickness = getProfileSettingFloat('solid_layer_thickness')
946 if layerHeight == 0.0:
948 return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
950 def calculateObjectSizeOffsets():
953 if getProfileSetting('platform_adhesion') == 'Brim':
954 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
955 elif getProfileSetting('platform_adhesion') == 'Raft':
958 if getProfileSettingFloat('skirt_line_count') > 0:
959 size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
961 #if getProfileSetting('enable_raft') != 'False':
962 # size += profile.getProfileSettingFloat('raft_margin') * 2
963 #if getProfileSetting('support') != 'None':
964 # extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
965 # extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
968 def getMachineCenterCoords():
969 if getMachineSetting('machine_center_is_zero') == 'True':
971 return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
973 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
974 # the rest of the polygons are the dis-allowed areas of the machine.
975 def getMachineSizePolygons():
976 size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
978 if getMachineSetting('machine_shape') == 'Circular':
979 # Circle platform for delta printers...
982 for n in xrange(0, steps):
983 circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[1]/2])
984 ret.append(numpy.array(circle, numpy.float32))
986 ret.append(numpy.array([[-size[0]/2,-size[1]/2],[size[0]/2,-size[1]/2],[size[0]/2, size[1]/2], [-size[0]/2, size[1]/2]], numpy.float32))
988 if getMachineSetting('machine_type') == 'ultimaker2':
992 ret.append(numpy.array([[-size[0]/2,-size[1]/2],[-size[0]/2+w+2,-size[1]/2], [-size[0]/2+w,-size[1]/2+h], [-size[0]/2,-size[1]/2+h]], numpy.float32))
993 ret.append(numpy.array([[ size[0]/2-w-2,-size[1]/2],[ size[0]/2,-size[1]/2], [ size[0]/2,-size[1]/2+h],[ size[0]/2-w,-size[1]/2+h]], numpy.float32))
994 ret.append(numpy.array([[-size[0]/2+w+2, size[1]/2],[-size[0]/2, size[1]/2], [-size[0]/2, size[1]/2-h],[-size[0]/2+w, size[1]/2-h]], numpy.float32))
995 ret.append(numpy.array([[ size[0]/2, size[1]/2],[ size[0]/2-w-2, size[1]/2], [ size[0]/2-w, size[1]/2-h],[ size[0]/2, size[1]/2-h]], numpy.float32))
998 #returns the number of extruders minimal used. Normally this returns 1, but with dual-extrusion support material it returns 2
999 def minimalExtruderCount():
1000 if int(getMachineSetting('extruder_amount')) < 2:
1002 if getProfileSetting('support') == 'None':
1004 if getProfileSetting('support_dual_extrusion') == 'Second extruder':
1008 def getGCodeExtension():
1009 if getMachineSetting('gcode_flavor') == 'BFB':
1013 #########################################################
1014 ## Alteration file functions
1015 #########################################################
1016 def replaceTagMatch(m):
1020 return pre + time.strftime('%H:%M:%S')
1022 return pre + time.strftime('%d-%m-%Y')
1024 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
1025 if tag == 'print_time':
1026 return pre + '#P_TIME#'
1027 if tag == 'filament_amount':
1028 return pre + '#F_AMNT#'
1029 if tag == 'filament_weight':
1030 return pre + '#F_WGHT#'
1031 if tag == 'filament_cost':
1032 return pre + '#F_COST#'
1033 if tag == 'profile_string':
1034 return pre + 'CURA_PROFILE_STRING:%s' % (getProfileString())
1035 if pre == 'F' and tag == 'max_z_speed':
1036 f = getProfileSettingFloat('travel_speed') * 60
1037 if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
1038 f = getProfileSettingFloat(tag) * 60
1039 elif isProfileSetting(tag):
1040 f = getProfileSettingFloat(tag)
1041 elif isPreference(tag):
1042 f = getProfileSettingFloat(tag)
1044 return '%s?%s?' % (pre, tag)
1046 return pre + str(int(f))
1049 def replaceGCodeTags(filename, gcodeInt):
1050 f = open(filename, 'r+')
1052 data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
1053 data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
1054 data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
1055 cost = gcodeInt.calculateCost()
1058 data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
1063 def replaceGCodeTagsFromSlicer(filename, slicerInt):
1064 f = open(filename, 'r+')
1066 data = data.replace('#P_TIME#', ('%8.2f' % (int(slicerInt._printTimeSeconds)))[-8:])
1067 data = data.replace('#F_AMNT#', ('%8.2f' % (slicerInt._filamentMM[0]))[-8:])
1068 data = data.replace('#F_WGHT#', ('%8.2f' % (float(slicerInt.getFilamentWeight()) * 1000))[-8:])
1069 cost = slicerInt.getFilamentCost()
1072 data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
1077 ### Get aleration raw contents. (Used internally in Cura)
1078 def getAlterationFile(filename):
1079 if filename in tempOverride:
1080 return tempOverride[filename]
1081 global settingsDictionary
1082 if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
1083 return settingsDictionary[filename].getValue()
1084 traceback.print_stack()
1085 sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
1088 def setAlterationFile(name, value):
1089 #Check if we have a configuration file loaded, else load the default.
1090 global settingsDictionary
1091 if name in settingsDictionary and settingsDictionary[name].isAlteration():
1092 settingsDictionary[name].setValue(value)
1093 saveProfile(getDefaultProfilePath(), True)
1095 def isTagIn(tag, contents):
1096 contents = re.sub(';[^\n]*\n', '', contents)
1097 return tag in contents
1099 ### Get the alteration file for output. (Used by Skeinforge)
1100 def getAlterationFileContents(filename, extruderCount = 1):
1103 alterationContents = getAlterationFile(filename)
1104 if getMachineSetting('gcode_flavor') == 'UltiGCode':
1105 if filename == 'end.gcode':
1106 return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
1108 if filename == 'start.gcode':
1109 if extruderCount > 1:
1110 alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
1111 #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.
1112 #We also set our steps per E here, if configured.
1113 eSteps = getMachineSettingFloat('steps_per_e')
1115 prefix += 'M92 E%f\n' % (eSteps)
1116 temp = getProfileSettingFloat('print_temperature')
1118 if getMachineSetting('has_heated_bed') == 'True':
1119 bedTemp = getProfileSettingFloat('print_bed_temperature')
1121 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1122 prefix += 'M140 S%f\n' % (bedTemp)
1123 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1124 if extruderCount > 0:
1125 for n in xrange(1, extruderCount):
1127 if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1128 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1129 prefix += 'M104 T%d S%f\n' % (n, t)
1130 for n in xrange(0, extruderCount):
1132 if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1133 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1134 prefix += 'M109 T%d S%f\n' % (n, t)
1137 prefix += 'M109 S%f\n' % (temp)
1138 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1139 prefix += 'M190 S%f\n' % (bedTemp)
1140 elif filename == 'end.gcode':
1141 if extruderCount > 1:
1142 alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1143 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1144 #postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1145 return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'