Cura/util/profile.py

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