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