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', 20, int, 'expert', _('Support')).setRange(0,100).setLabel(_("Fill amount (%)"), _("Amount of infill structure in the support material, less material gives weaker support which is easier to remove. 20% seems to be a good average."))
 207 setting('support_xy_distance', 0.7, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance X/Y (mm)"), _("Distance of the support material from the print, in the X/Y directions.\n0.7mm gives a nice distance from the print so the support does not stick to the print."))
 208 setting('support_z_distance', 0.15, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance Z (mm)"), _("Distance from the top/bottom of the support to the print. A small gap here makes it easier to remove the support but makes the print a bit uglier.\n0.15mm gives a good seperation of the support material."))
 209 #setting('support_distance',  0.5, float, 'expert', _('Support')).setRange(0).setLabel(_("Distance from object (mm)"), _("Distance between the support structure and the object. Empty gap in which no support structure is printed."))
 210 #setting('joris', False, bool, 'expert', 'Joris').setLabel(_("Spiralize the outer contour"), _("[Joris] is a code name for smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. It is intended to be used with a single walled wall thickness to make cups/vases."))
 211 #setting('bridge_speed', 100, int, 'expert', 'Bridge').setRange(0,100).setLabel(_("Bridge speed (%)"), _("Speed at which layers with bridges are printed, compared to normal printing speed."))
 212 setting('brim_line_count', 20, int, 'expert', _('Brim')).setRange(1,100).setLabel(_("Brim line amount"), _("The amount of lines used for a brim, more lines means a larger brim which sticks better, but this also makes your effective print area smaller."))
 213 setting('raft_margin', 5, float, 'expert', _('Raft')).setRange(0).setLabel(_("Extra margin (mm)"), _("If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft while using more material and leaving less are for your print."))
 214 setting('raft_line_spacing', 1.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Line spacing (mm)"), _("When you are using the raft this is the distance between the centerlines of the raft line."))
 215 setting('raft_base_thickness', 0.3, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base thickness (mm)"), _("When you are using the raft this is the thickness of the base layer which is put down."))
 216 setting('raft_base_linewidth', 0.7, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base line width (mm)"), _("When you are using the raft this is the width of the base layer lines which are put down."))
 217 setting('raft_interface_thickness', 0.2, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface thickness (mm)"), _("When you are using the raft this is the thickness of the interface layer which is put down."))
 218 setting('raft_interface_linewidth', 0.2, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface line width (mm)"), _("When you are using the raft this is the width of the interface layer lines which are put down."))
 219 #setting('hop_on_move', False, bool, 'expert', 'Hop').setLabel(_("Enable hop on move"), _("When moving from print position to print position, raise the printer head 0.2mm so it does not knock off the print (experimental)."))
 220 setting('fix_horrible_union_all_type_a', False, bool, 'expert', _('Fix horrible')).setLabel(_("Combine everything (Type-A)"), _("This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer."))
 221 setting('fix_horrible_union_all_type_b', False, bool, 'expert', _('Fix horrible')).setLabel(_("Combine everything (Type-B)"), _("This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is depended on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer."))
 222 setting('fix_horrible_use_open_bits', False, bool, 'expert', _('Fix horrible')).setLabel(_("Keep open faces"), _("This expert option keeps all the open bits of the model intact. Normally Cura tries to stitch up small holes and remove everything with big holes, but this option keeps bits that are not properly part of anything and just goes with whatever it is left. This option is usually not what you want, but it might enable you to slice models otherwise failing to produce proper paths.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk."))
 223 setting('fix_horrible_extensive_stitching', False, bool, 'expert', _('Fix horrible')).setLabel(_("Extensive stitching"), _("Extrensive stitching tries to fix up open holes in the model by closing the hole with touching polygons. This algorthm is quite expensive and could introduce a lot of processing time.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk."))
 224
 225 setting('plugin_config', '', str, 'hidden', 'hidden')
 226 setting('object_center_x', -1, float, 'hidden', 'hidden')
 227 setting('object_center_y', -1, float, 'hidden', 'hidden')
 228
 229 setting('start.gcode', """;Sliced at: {day} {date} {time}
 230 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
 231 ;Print time: {print_time}
 232 ;Filament used: {filament_amount}m {filament_weight}g
 233 ;Filament cost: {filament_cost}
 234 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
 235 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
 236 G21        ;metric values
 237 G90        ;absolute positioning
 238 M107       ;start with the fan off
 239
 240 G28 X0 Y0  ;move X/Y to min endstops
 241 G28 Z0     ;move Z to min endstops
 242
 243 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
 244
 245 G92 E0                  ;zero the extruded length
 246 G1 F200 E3              ;extrude 3mm of feed stock
 247 G92 E0                  ;zero the extruded length again
 248 G1 F{travel_speed}
 249 ;Put printing message on LCD screen
 250 M117 Printing...
 251 """, str, 'alteration', 'alteration')
 252 #######################################################################################
 253 setting('end.gcode', """;End GCode
 254 M104 S0                     ;extruder heater off
 255 M140 S0                     ;heated bed heater off (if you have it)
 256
 257 G91                                    ;relative positioning
 258 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
 259 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
 260 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
 261
 262 M84                         ;steppers off
 263 G90                         ;absolute positioning
 264 """, str, 'alteration', 'alteration')
 265 #######################################################################################
 266 setting('start2.gcode', """;Sliced at: {day} {date} {time}
 267 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
 268 ;Print time: {print_time}
 269 ;Filament used: {filament_amount}m {filament_weight}g
 270 ;Filament cost: {filament_cost}
 271 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
 272 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
 273 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
 274 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
 275 G21        ;metric values
 276 G90        ;absolute positioning
 277 M107       ;start with the fan off
 278
 279 G28 X0 Y0  ;move X/Y to min endstops
 280 G28 Z0     ;move Z to min endstops
 281
 282 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
 283
 284 T1                      ;Switch to the 2nd extruder
 285 G92 E0                  ;zero the extruded length
 286 G1 F200 E10             ;extrude 10mm of feed stock
 287 G92 E0                  ;zero the extruded length again
 288 G1 F200 E-{retraction_dual_amount}
 289
 290 T0                      ;Switch to the first extruder
 291 G92 E0                  ;zero the extruded length
 292 G1 F200 E10             ;extrude 10mm of feed stock
 293 G92 E0                  ;zero the extruded length again
 294 G1 F{travel_speed}
 295 ;Put printing message on LCD screen
 296 M117 Printing...
 297 """, str, 'alteration', 'alteration')
 298 #######################################################################################
 299 setting('end2.gcode', """;End GCode
 300 M104 T0 S0                     ;extruder heater off
 301 M104 T1 S0                     ;extruder heater off
 302 M140 S0                     ;heated bed heater off (if you have it)
 303
 304 G91                                    ;relative positioning
 305 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
 306 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
 307 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
 308
 309 M84                         ;steppers off
 310 G90                         ;absolute positioning
 311 """, str, 'alteration', 'alteration')
 312 #######################################################################################
 313 setting('support_start.gcode', '', str, 'alteration', 'alteration')
 314 setting('support_end.gcode', '', str, 'alteration', 'alteration')
 315 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
 316 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
 317 setting('replace.csv', '', str, 'alteration', 'alteration')
 318 #######################################################################################
 319 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
 320 G92 E0
 321 G1 E-36 F5000
 322 G92 E0
 323 T{extruder}
 324 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
 325 G1 E36 F5000
 326 G92 E0
 327 """, str, 'alteration', 'alteration')
 328
 329 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
 330 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
 331 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."))
 332 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."))
 333 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."))
 334 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."))
 335 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
 336 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve next versions of Cura"))
 337 setting('youmagine_token', '', str, 'preference', 'hidden')
 338 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."))
 339 setting('language', 'English', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
 340 setting('active_machine', '0', int, 'preference', 'hidden')
 341
 342 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel(_('Model colour'))
 343 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'))
 344 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'))
 345 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'))
 346
 347 setting('window_maximized', 'True', bool, 'preference', 'hidden')
 348 setting('window_pos_x', '-1', float, 'preference', 'hidden')
 349 setting('window_pos_y', '-1', float, 'preference', 'hidden')
 350 setting('window_width', '-1', float, 'preference', 'hidden')
 351 setting('window_height', '-1', float, 'preference', 'hidden')
 352 setting('window_normal_sash', '320', float, 'preference', 'hidden')
 353
 354 setting('machine_name', '', str, 'machine', 'hidden')
 355 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
 356 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Size of the machine in mm"))
 357 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
 358 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine in mm"))
 359 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."))
 360 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
 361 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have an heated bed, this enabled heated bed settings (requires restart)"))
 362 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."))
 363 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
 364 setting('extruder_offset_x1', '-21.6', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
 365 setting('extruder_offset_y1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
 366 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
 367 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
 368 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
 369 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
 370 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."))
 371 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
 372 setting('serial_port_auto', '', str, 'machine', 'hidden')
 373 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"))
 374 setting('serial_baud_auto', '', int, 'machine', 'hidden')
 375
 376 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."))
 377 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."))
 378 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."))
 379 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."))
 380 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."))
 381
 382 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
 383 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
 384 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."))
 385 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
 386 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
 387 validators.printSpeedValidator(settingsDictionary['print_speed'])
 388 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
 389 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
 390 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
 391 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
 392 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
 393 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
 394 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
 395 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
 396 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
 397 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."))
 398
 399 #Conditions for multiple extruders
 400 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
 401 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
 402 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
 403 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
 404 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
 405 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
 406 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
 407 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
 408 #Heated bed
 409 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
 410
 411 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
 412 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 413 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 414 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 415 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 416 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 417 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 418 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 419 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 420 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 421 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 422 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 423 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 424 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
 425
 426 #Remove fake defined _() because later the localization will define a global _()
 427 del _
 428
 429 #########################################################
 430 ## Profile and preferences functions
 431 #########################################################
 432
 433 def getSubCategoriesFor(category):
 434         done = {}
 435         ret = []
 436         for s in settingsList:
 437                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
 438                         done[s.getSubCategory()] = True
 439                         ret.append(s.getSubCategory())
 440         return ret
 441
 442 def getSettingsForCategory(category, subCategory = None):
 443         ret = []
 444         for s in settingsList:
 445                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
 446                         ret.append(s)
 447         return ret
 448
 449 ## Profile functions
 450 def getBasePath():
 451         if platform.system() == "Windows":
 452                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
 453                 #If we have a frozen python install, we need to step out of the library.zip
 454                 if hasattr(sys, 'frozen'):
 455                         basePath = os.path.normpath(os.path.join(basePath, ".."))
 456         else:
 457                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
 458         if not os.path.isdir(basePath):
 459                 os.makedirs(basePath)
 460         return basePath
 461
 462 def getAlternativeBasePaths():
 463         paths = []
 464         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
 465         for subPath in os.listdir(basePath):
 466                 path = os.path.join(basePath, subPath)
 467                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
 468                         paths.append(path)
 469                 path = os.path.join(basePath, subPath, 'Cura')
 470                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
 471                         paths.append(path)
 472         return paths
 473
 474 def getDefaultProfilePath():
 475         return os.path.join(getBasePath(), 'current_profile.ini')
 476
 477 def loadProfile(filename):
 478         #Read a configuration file as global config
 479         profileParser = ConfigParser.ConfigParser()
 480         try:
 481                 profileParser.read(filename)
 482         except ConfigParser.ParsingError:
 483                 return
 484         global settingsList
 485         for set in settingsList:
 486                 if set.isPreference():
 487                         continue
 488                 section = 'profile'
 489                 if set.isAlteration():
 490                         section = 'alterations'
 491                 if profileParser.has_option(section, set.getName()):
 492                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
 493
 494 def saveProfile(filename):
 495         #Save the current profile to an ini file
 496         profileParser = ConfigParser.ConfigParser()
 497         profileParser.add_section('profile')
 498         profileParser.add_section('alterations')
 499         global settingsList
 500         for set in settingsList:
 501                 if set.isPreference() or set.isMachineSetting():
 502                         continue
 503                 if set.isAlteration():
 504                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
 505                 else:
 506                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
 507
 508         profileParser.write(open(filename, 'w'))
 509
 510 def resetProfile():
 511         #Read a configuration file as global config
 512         global settingsList
 513         for set in settingsList:
 514                 if not set.isProfile():
 515                         continue
 516                 set.setValue(set.getDefault())
 517
 518         if getMachineSetting('machine_type') == 'ultimaker':
 519                 putProfileSetting('nozzle_size', '0.4')
 520                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
 521                         putProfileSetting('retraction_enable', 'True')
 522         elif getMachineSetting('machine_type') == 'ultimaker2':
 523                 putProfileSetting('nozzle_size', '0.4')
 524                 putProfileSetting('retraction_enable', 'True')
 525         else:
 526                 putProfileSetting('nozzle_size', '0.5')
 527                 putProfileSetting('retraction_enable', 'True')
 528
 529 def setProfileFromString(options):
 530         options = base64.b64decode(options)
 531         options = zlib.decompress(options)
 532         (profileOpts, alt) = options.split('\f', 1)
 533         global settingsDictionary
 534         for option in profileOpts.split('\b'):
 535                 if len(option) > 0:
 536                         (key, value) = option.split('=', 1)
 537                         if key in settingsDictionary:
 538                                 if settingsDictionary[key].isProfile():
 539                                         settingsDictionary[key].setValue(value)
 540         for option in alt.split('\b'):
 541                 if len(option) > 0:
 542                         (key, value) = option.split('=', 1)
 543                         if key in settingsDictionary:
 544                                 if settingsDictionary[key].isAlteration():
 545                                         settingsDictionary[key].setValue(value)
 546
 547 def getProfileString():
 548         p = []
 549         alt = []
 550         global settingsList
 551         for set in settingsList:
 552                 if set.isProfile():
 553                         if set.getName() in tempOverride:
 554                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
 555                         else:
 556                                 p.append(set.getName() + "=" + set.getValue())
 557                 elif set.isAlteration():
 558                         if set.getName() in tempOverride:
 559                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
 560                         else:
 561                                 alt.append(set.getName() + "=" + set.getValue())
 562         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
 563         ret = base64.b64encode(zlib.compress(ret, 9))
 564         return ret
 565
 566 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
 567         lines = []
 568         for i in xrange(0, len(string), every):
 569                 lines.append(string[i:i+every])
 570         return '\n'.join(lines)
 571
 572 def getPreferencesString():
 573         p = []
 574         global settingsList
 575         for set in settingsList:
 576                 if set.isPreference():
 577                         p.append(set.getName() + "=" + set.getValue())
 578         ret = '\b'.join(p)
 579         ret = base64.b64encode(zlib.compress(ret, 9))
 580         return ret
 581
 582
 583 def getProfileSetting(name):
 584         if name in tempOverride:
 585                 return tempOverride[name]
 586         global settingsDictionary
 587         if name in settingsDictionary and settingsDictionary[name].isProfile():
 588                 return settingsDictionary[name].getValue()
 589         traceback.print_stack()
 590         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
 591         return ''
 592
 593 def getProfileSettingFloat(name):
 594         try:
 595                 setting = getProfileSetting(name).replace(',', '.')
 596                 return float(eval(setting, {}, {}))
 597         except:
 598                 return 0.0
 599
 600 def putProfileSetting(name, value):
 601         #Check if we have a configuration file loaded, else load the default.
 602         global settingsDictionary
 603         if name in settingsDictionary and settingsDictionary[name].isProfile():
 604                 settingsDictionary[name].setValue(value)
 605
 606 def isProfileSetting(name):
 607         global settingsDictionary
 608         if name in settingsDictionary and settingsDictionary[name].isProfile():
 609                 return True
 610         return False
 611
 612 ## Preferences functions
 613 def getPreferencePath():
 614         return os.path.join(getBasePath(), 'preferences.ini')
 615
 616 def getPreferenceFloat(name):
 617         try:
 618                 setting = getPreference(name).replace(',', '.')
 619                 return float(eval(setting, {}, {}))
 620         except:
 621                 return 0.0
 622
 623 def getPreferenceColour(name):
 624         colorString = getPreference(name)
 625         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
 626
 627 def loadPreferences(filename):
 628         global settingsList
 629         #Read a configuration file as global config
 630         profileParser = ConfigParser.ConfigParser()
 631         try:
 632                 profileParser.read(filename)
 633         except ConfigParser.ParsingError:
 634                 return
 635
 636         for set in settingsList:
 637                 if set.isPreference():
 638                         if profileParser.has_option('preference', set.getName()):
 639                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
 640
 641         n = 0
 642         while profileParser.has_section('machine_%d' % (n)):
 643                 for set in settingsList:
 644                         if set.isMachineSetting():
 645                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
 646                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
 647                 n += 1
 648
 649         setActiveMachine(int(getPreferenceFloat('active_machine')))
 650
 651 def loadMachineSettings(filename):
 652         global settingsList
 653         #Read a configuration file as global config
 654         profileParser = ConfigParser.ConfigParser()
 655         try:
 656                 profileParser.read(filename)
 657         except ConfigParser.ParsingError:
 658                 return
 659
 660         for set in settingsList:
 661                 if set.isMachineSetting():
 662                         if profileParser.has_option('machine', set.getName()):
 663                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
 664         checkAndUpdateMachineName()
 665
 666 def savePreferences(filename):
 667         global settingsList
 668         #Save the current profile to an ini file
 669         parser = ConfigParser.ConfigParser()
 670         parser.add_section('preference')
 671
 672         for set in settingsList:
 673                 if set.isPreference():
 674                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
 675
 676         n = 0
 677         while getMachineSetting('machine_name', n) != '':
 678                 parser.add_section('machine_%d' % (n))
 679                 for set in settingsList:
 680                         if set.isMachineSetting():
 681                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
 682                 n += 1
 683         parser.write(open(filename, 'w'))
 684
 685 def getPreference(name):
 686         if name in tempOverride:
 687                 return tempOverride[name]
 688         global settingsDictionary
 689         if name in settingsDictionary and settingsDictionary[name].isPreference():
 690                 return settingsDictionary[name].getValue()
 691         traceback.print_stack()
 692         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
 693         return ''
 694
 695 def putPreference(name, value):
 696         #Check if we have a configuration file loaded, else load the default.
 697         global settingsDictionary
 698         if name in settingsDictionary and settingsDictionary[name].isPreference():
 699                 settingsDictionary[name].setValue(value)
 700                 savePreferences(getPreferencePath())
 701                 return
 702         traceback.print_stack()
 703         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
 704
 705 def isPreference(name):
 706         global settingsDictionary
 707         if name in settingsDictionary and settingsDictionary[name].isPreference():
 708                 return True
 709         return False
 710
 711 def getMachineSettingFloat(name):
 712         try:
 713                 setting = getMachineSetting(name).replace(',', '.')
 714                 return float(eval(setting, {}, {}))
 715         except:
 716                 return 0.0
 717
 718 def getMachineSetting(name, index = None):
 719         if name in tempOverride:
 720                 return tempOverride[name]
 721         global settingsDictionary
 722         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
 723                 return settingsDictionary[name].getValue(index)
 724         traceback.print_stack()
 725         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
 726         return ''
 727
 728 def putMachineSetting(name, value):
 729         #Check if we have a configuration file loaded, else load the default.
 730         global settingsDictionary
 731         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
 732                 settingsDictionary[name].setValue(value)
 733         savePreferences(getPreferencePath())
 734
 735 def isMachineSetting(name):
 736         global settingsDictionary
 737         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
 738                 return True
 739         return False
 740
 741 def checkAndUpdateMachineName():
 742         global _selectedMachineIndex
 743         name = getMachineSetting('machine_name')
 744         index = None
 745         if name == '':
 746                 name = getMachineSetting('machine_type')
 747         for n in xrange(0, getMachineCount()):
 748                 if n == _selectedMachineIndex:
 749                         continue
 750                 if index is None:
 751                         if name == getMachineSetting('machine_name', n):
 752                                 index = 1
 753                 else:
 754                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
 755                                 index += 1
 756         if index is not None:
 757                 name = '%s (%d)' % (name, index)
 758         putMachineSetting('machine_name', name)
 759         putPreference('active_machine', _selectedMachineIndex)
 760
 761 def getMachineCount():
 762         n = 0
 763         while getMachineSetting('machine_name', n) != '':
 764                 n += 1
 765         if n < 1:
 766                 return 1
 767         return n
 768
 769 def setActiveMachine(index):
 770         global _selectedMachineIndex
 771         _selectedMachineIndex = index
 772         putPreference('active_machine', _selectedMachineIndex)
 773
 774 def removeMachine(index):
 775         global _selectedMachineIndex
 776         global settingsList
 777         if getMachineCount() < 2:
 778                 return
 779         for n in xrange(index, getMachineCount()):
 780                 for setting in settingsList:
 781                         if setting.isMachineSetting():
 782                                 setting.setValue(setting.getValue(n+1), n)
 783
 784         if _selectedMachineIndex >= index:
 785                 setActiveMachine(getMachineCount() - 1)
 786
 787 ## Temp overrides for multi-extruder slicing and the project planner.
 788 tempOverride = {}
 789 def setTempOverride(name, value):
 790         tempOverride[name] = unicode(value).encode("utf-8")
 791 def clearTempOverride(name):
 792         del tempOverride[name]
 793 def resetTempOverride():
 794         tempOverride.clear()
 795
 796 #########################################################
 797 ## Utility functions to calculate common profile values
 798 #########################################################
 799 def calculateEdgeWidth():
 800         wallThickness = getProfileSettingFloat('wall_thickness')
 801         nozzleSize = getProfileSettingFloat('nozzle_size')
 802
 803         if wallThickness < 0.01:
 804                 return nozzleSize
 805         if wallThickness < nozzleSize:
 806                 return wallThickness
 807
 808         lineCount = int(wallThickness / (nozzleSize - 0.0001))
 809         if lineCount == 0:
 810                 return nozzleSize
 811         lineWidth = wallThickness / lineCount
 812         lineWidthAlt = wallThickness / (lineCount + 1)
 813         if lineWidth > nozzleSize * 1.5:
 814                 return lineWidthAlt
 815         return lineWidth
 816
 817 def calculateLineCount():
 818         wallThickness = getProfileSettingFloat('wall_thickness')
 819         nozzleSize = getProfileSettingFloat('nozzle_size')
 820
 821         if wallThickness < 0.01:
 822                 return 0
 823         if wallThickness < nozzleSize:
 824                 return 1
 825
 826         lineCount = int(wallThickness / (nozzleSize - 0.0001))
 827         if lineCount < 1:
 828                 lineCount = 1
 829         lineWidth = wallThickness / lineCount
 830         lineWidthAlt = wallThickness / (lineCount + 1)
 831         if lineWidth > nozzleSize * 1.5:
 832                 return lineCount + 1
 833         return lineCount
 834
 835 def calculateSolidLayerCount():
 836         layerHeight = getProfileSettingFloat('layer_height')
 837         solidThickness = getProfileSettingFloat('solid_layer_thickness')
 838         if layerHeight == 0.0:
 839                 return 1
 840         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
 841
 842 def calculateObjectSizeOffsets():
 843         size = 0.0
 844
 845         if getProfileSetting('platform_adhesion') == 'Brim':
 846                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
 847         elif getProfileSetting('platform_adhesion') == 'Raft':
 848                 pass
 849         else:
 850                 if getProfileSettingFloat('skirt_line_count') > 0:
 851                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
 852
 853         #if getProfileSetting('enable_raft') != 'False':
 854         #       size += profile.getProfileSettingFloat('raft_margin') * 2
 855         #if getProfileSetting('support') != 'None':
 856         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
 857         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
 858         return [size, size]
 859
 860 def getMachineCenterCoords():
 861         if getMachineSetting('machine_center_is_zero') == 'True':
 862                 return [0, 0]
 863         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
 864
 865 #########################################################
 866 ## Alteration file functions
 867 #########################################################
 868 def replaceTagMatch(m):
 869         pre = m.group(1)
 870         tag = m.group(2)
 871         if tag == 'time':
 872                 return pre + time.strftime('%H:%M:%S')
 873         if tag == 'date':
 874                 return pre + time.strftime('%d-%m-%Y')
 875         if tag == 'day':
 876                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
 877         if tag == 'print_time':
 878                 return pre + '#P_TIME#'
 879         if tag == 'filament_amount':
 880                 return pre + '#F_AMNT#'
 881         if tag == 'filament_weight':
 882                 return pre + '#F_WGHT#'
 883         if tag == 'filament_cost':
 884                 return pre + '#F_COST#'
 885         if pre == 'F' and tag == 'max_z_speed':
 886                 f = getProfileSettingFloat('travel_speed') * 60
 887         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
 888                 f = getProfileSettingFloat(tag) * 60
 889         elif isProfileSetting(tag):
 890                 f = getProfileSettingFloat(tag)
 891         elif isPreference(tag):
 892                 f = getProfileSettingFloat(tag)
 893         else:
 894                 return '%s?%s?' % (pre, tag)
 895         if (f % 1) == 0:
 896                 return pre + str(int(f))
 897         return pre + str(f)
 898
 899 def replaceGCodeTags(filename, gcodeInt):
 900         f = open(filename, 'r+')
 901         data = f.read(2048)
 902         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
 903         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
 904         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
 905         cost = gcodeInt.calculateCost()
 906         if cost is None:
 907                 cost = 'Unknown'
 908         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
 909         f.seek(0)
 910         f.write(data)
 911         f.close()
 912
 913 ### Get aleration raw contents. (Used internally in Cura)
 914 def getAlterationFile(filename):
 915         if filename in tempOverride:
 916                 return tempOverride[filename]
 917         global settingsDictionary
 918         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
 919                 return settingsDictionary[filename].getValue()
 920         traceback.print_stack()
 921         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
 922         return ''
 923
 924 def setAlterationFile(name, value):
 925         #Check if we have a configuration file loaded, else load the default.
 926         global settingsDictionary
 927         if name in settingsDictionary and settingsDictionary[name].isAlteration():
 928                 settingsDictionary[name].setValue(value)
 929         saveProfile(getDefaultProfilePath())
 930
 931 def isTagIn(tag, contents):
 932         contents = re.sub(';[^\n]*\n', '', contents)
 933         return tag in contents
 934
 935 ### Get the alteration file for output. (Used by Skeinforge)
 936 def getAlterationFileContents(filename, extruderCount = 1):
 937         prefix = ''
 938         postfix = ''
 939         alterationContents = getAlterationFile(filename)
 940         if getMachineSetting('gcode_flavor') == 'UltiGCode':
 941                 return ''
 942         if filename == 'start.gcode':
 943                 if extruderCount > 1:
 944                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
 945                 #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.
 946                 #We also set our steps per E here, if configured.
 947                 eSteps = getMachineSettingFloat('steps_per_e')
 948                 if eSteps > 0:
 949                         prefix += 'M92 E%f\n' % (eSteps)
 950                 temp = getProfileSettingFloat('print_temperature')
 951                 bedTemp = 0
 952                 if getMachineSetting('has_heated_bed') == 'True':
 953                         bedTemp = getProfileSettingFloat('print_bed_temperature')
 954
 955                 if bedTemp > 0 and isTagIn('{print_bed_temperature}', alterationContents):
 956                         prefix += 'M140 S%f\n' % (bedTemp)
 957                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
 958                         if extruderCount > 0:
 959                                 for n in xrange(1, extruderCount):
 960                                         t = temp
 961                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
 962                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
 963                                         prefix += 'M104 T%d S%f\n' % (n, t)
 964                                 for n in xrange(0, extruderCount):
 965                                         t = temp
 966                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
 967                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
 968                                         prefix += 'M109 T%d S%f\n' % (n, t)
 969                                 prefix += 'T0\n'
 970                         else:
 971                                 prefix += 'M109 S%f\n' % (temp)
 972                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
 973                         prefix += 'M190 S%f\n' % (bedTemp)
 974         elif filename == 'end.gcode':
 975                 if extruderCount > 1:
 976                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
 977                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
 978                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
 979         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
 980
 981 ###### PLUGIN #####
 982
 983 def getPluginConfig():
 984         try:
 985                 return pickle.loads(str(getProfileSetting('plugin_config')))
 986         except:
 987                 return []
 988
 989 def setPluginConfig(config):
 990         putProfileSetting('plugin_config', pickle.dumps(config))
 991
 992 def getPluginBasePaths():
 993         ret = []
 994         if platform.system() != "Windows":
 995                 ret.append(os.path.expanduser('~/.cura/plugins/'))
 996         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
 997                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
 998         else:
 999                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
1000         return ret
1001
1002 def getPluginList():
1003         ret = []
1004         for basePath in getPluginBasePaths():
1005                 for filename in glob.glob(os.path.join(basePath, '*.py')):
1006                         filename = os.path.basename(filename)
1007                         if filename.startswith('_'):
1008                                 continue
1009                         with open(os.path.join(basePath, filename), "r") as f:
1010                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
1011                                 for line in f:
1012                                         line = line.strip()
1013                                         if not line.startswith('#'):
1014                                                 break
1015                                         line = line[1:].split(':', 1)
1016                                         if len(line) != 2:
1017                                                 continue
1018                                         if line[0].upper() == 'NAME':
1019                                                 item['name'] = line[1].strip()
1020                                         elif line[0].upper() == 'INFO':
1021                                                 item['info'] = line[1].strip()
1022                                         elif line[0].upper() == 'TYPE':
1023                                                 item['type'] = line[1].strip()
1024                                         elif line[0].upper() == 'DEPEND':
1025                                                 pass
1026                                         elif line[0].upper() == 'PARAM':
1027                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
1028                                                 if m is not None:
1029                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
1030                                         else:
1031                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
1032                                 if item['name'] is not None and item['type'] == 'postprocess':
1033                                         ret.append(item)
1034         return ret
1035
1036 def runPostProcessingPlugins(gcodefilename):
1037         pluginConfigList = getPluginConfig()
1038         pluginList = getPluginList()
1039
1040         for pluginConfig in pluginConfigList:
1041                 plugin = None
1042                 for pluginTest in pluginList:
1043                         if pluginTest['filename'] == pluginConfig['filename']:
1044                                 plugin = pluginTest
1045                 if plugin is None:
1046                         continue
1047
1048                 pythonFile = None
1049                 for basePath in getPluginBasePaths():
1050                         testFilename = os.path.join(basePath, pluginConfig['filename'])
1051                         if os.path.isfile(testFilename):
1052                                 pythonFile = testFilename
1053                 if pythonFile is None:
1054                         continue
1055
1056                 locals = {'filename': gcodefilename}
1057                 for param in plugin['params']:
1058                         value = param['default']
1059                         if param['name'] in pluginConfig['params']:
1060                                 value = pluginConfig['params'][param['name']]
1061
1062                         if param['type'] == 'float':
1063                                 try:
1064                                         value = float(value)
1065                                 except:
1066                                         value = float(param['default'])
1067
1068                         locals[param['name']] = value
1069                 try:
1070                         execfile(pythonFile, locals)
1071                 except:
1072                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
1073                         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])
1074         return None