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