Cura/util/profile.py

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