Cura/CuraEngineBackend.py

463 lines
25 KiB
Python

from UM.Backend.Backend import Backend
from UM.Application import Application
from UM.Scene.SceneNode import SceneNode
from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator
from UM.Preferences import Preferences
from UM.Math.Vector import Vector
from UM.Signal import Signal
from . import Cura_pb2
from . import ProcessSlicedObjectListJob
from . import ProcessGCodeJob
import os
import sys
import numpy
from PyQt5.QtCore import QTimer
class CuraEngineBackend(Backend):
def __init__(self):
super().__init__()
# Find out where the engine is located, and how it is called. This depends on how Cura is packaged and which OS we are running on.
default_engine_location = '../PinkUnicornEngine/CuraEngine'
if hasattr(sys, 'frozen'):
default_engine_location = os.path.join(os.path.dirname(os.path.abspath(sys.executable)), 'CuraEngine')
if sys.platform == 'win32':
default_engine_location += '.exe'
default_engine_location = os.path.abspath(default_engine_location)
Preferences.getInstance().addPreference('backend/location', default_engine_location)
self._scene = Application.getInstance().getController().getScene()
self._scene.sceneChanged.connect(self._onSceneChanged)
self._settings = None
Application.getInstance().activeMachineChanged.connect(self._onActiveMachineChanged)
self._onActiveMachineChanged()
self._changeTimer = QTimer()
self._changeTimer.setInterval(500)
self._changeTimer.setSingleShot(True)
self._changeTimer.timeout.connect(self._onChangeTimerFinished)
self._message_handlers[Cura_pb2.SlicedObjectList] = self._onSlicedObjectListMessage
self._message_handlers[Cura_pb2.Progress] = self._onProgressMessage
self._message_handlers[Cura_pb2.GCodeLayer] = self._onGCodeLayerMessage
self._message_handlers[Cura_pb2.GCodePrefix] = self._onGCodePrefixMessage
self._message_handlers[Cura_pb2.ObjectPrintTime] = self._onObjectPrintTimeMessage
self._center = None
self._slicing = False
self._restart = False
self.backendConnected.connect(self._onBackendConnected)
def getEngineCommand(self):
return [Preferences.getInstance().getValue("backend/location"), '-vv', '--connect', "127.0.0.1:{0}".format(self._port)]
changeTimerFinished = Signal()
def _onSceneChanged(self, source):
if (type(source) is not SceneNode) or (source is self._scene.getRoot()):
return
self._onChanged()
def _onActiveMachineChanged(self):
if self._settings:
self._settings.settingChanged.disconnect(self._onSettingChanged)
self._settings = Application.getInstance().getActiveMachine()
if self._settings:
self._settings.settingChanged.connect(self._onSettingChanged)
self._onChanged()
def _onSettingChanged(self, setting):
self._onChanged()
def _onSlicedObjectListMessage(self, message):
job = ProcessSlicedObjectListJob.ProcessSlicedObjectListJob(message, self._center)
job.start()
def _onProgressMessage(self, message):
if message.amount >= 0.99:
self._slicing = False
self.processingProgress.emit(message.amount)
def _onGCodeLayerMessage(self, message):
job = ProcessGCodeJob.ProcessGCodeLayerJob(message)
job.start()
def _onGCodePrefixMessage(self, message):
self._scene.gcode_list.insert(0, message.data.decode('utf-8', 'replace'))
def _onObjectPrintTimeMessage(self, message):
pass
def _createSocket(self):
super()._createSocket()
self._socket.registerMessageType(1, Cura_pb2.ObjectList)
self._socket.registerMessageType(2, Cura_pb2.SlicedObjectList)
self._socket.registerMessageType(3, Cura_pb2.Progress)
self._socket.registerMessageType(4, Cura_pb2.GCodeLayer)
self._socket.registerMessageType(5, Cura_pb2.ObjectPrintTime)
self._socket.registerMessageType(6, Cura_pb2.SettingList)
self._socket.registerMessageType(7, Cura_pb2.GCodePrefix)
def _onChanged(self):
if not self._settings:
return
self._changeTimer.start()
def _onChangeTimerFinished(self):
if self._slicing:
self._slicing = False
self._restart = True
if self._process is not None:
try:
self._process.terminate()
except: # terminating a process that is already terminating causes an exception, silently ignore this.
pass
return
objects = []
for node in DepthFirstIterator(self._scene.getRoot()):
if type(node) is SceneNode and node.getMeshData():
if not getattr(node, '_outside_buildarea', False):
objects.append(node)
if not objects:
return #No point in slicing an empty build plate
self._slicing = True
self.processingProgress.emit(0.0)
self._sendSettings()
self._scene.acquireLock()
# Set the gcode as an empty list. This will be filled with strings by GCodeLayer messages.
# This is done so the gcode can be fragmented in memory and does not need a continues memory space.
# (AKA. This prevents MemoryErrors)
setattr(self._scene, 'gcode_list', [])
msg = Cura_pb2.ObjectList()
#TODO: All at once/one at a time mode
center = Vector()
for object in objects:
center += object.getPosition()
meshData = object.getMeshData().getTransformed(object.getWorldTransformation())
obj = msg.objects.add()
obj.id = id(object)
verts = numpy.array(meshData.getVertices(), copy=True)
verts[:,[1,2]] = verts[:,[2,1]]
obj.vertices = verts.tostring()
#if meshData.hasNormals():
#obj.normals = meshData.getNormalsAsByteArray()
#if meshData.hasIndices():
#obj.indices = meshData.getIndicesAsByteArray()
self._scene.releaseLock()
self._socket.sendMessage(msg)
## TODO: Neith settings need to be moved to their own backend.
def _sendSettings(self):
if self._settings.getSettingValueByKey('wireframe'):
self._sendSettings_neith()
else:
self._sendSettings_normal()
def _sendSettings_neith(self):
extruder = 0
settings = {
'neith': 1,
'extruderNr': extruder,
'printTemperature': int(self._settings.getSettingValueByKey('material_print_temperature')),
'bedTemperature': int(self._settings.getSettingValueByKey('material_bed_temperature')),
'filamentDiameter': int(self._settings.getSettingValueByKey('material_diameter') * 1000),
'retractionAmount': int(self._settings.getSettingValueByKey('retraction_amount') * 1000),
'retractionAmountPrime': int(0 * 1000),
# 'retractionAmountExtruderSwitch': int(fbk('') * 1000),
'retractionSpeed': int(self._settings.getSettingValueByKey('retraction_speed')),
'retractionPrimeSpeed': int(self._settings.getSettingValueByKey('retraction_speed')),
'retractionMinimalDistance': int(self._settings.getSettingValueByKey('retraction_min_travel') * 1000),
'retractionZHop': int(self._settings.getSettingValueByKey('retraction_hop') * 1000),
'moveSpeed': int(self._settings.getSettingValueByKey('speed_travel')),
'fanSpeedMin': self._settings.getSettingValueByKey('cool_fan_speed_min'),
'fanSpeedMax': self._settings.getSettingValueByKey('cool_fan_speed_max'),
# ================================
# wireframe printing options
# ================================
'wireframeConnectionHeight': int(self._settings.getSettingValueByKey('wireframe_height')*1000),
'wireframeNozzleClearance': int(self._settings.getSettingValueByKey('wireframe_nozzle_clearance')*1000),
'machineNozzleTipOuterDiameter': int(self._settings.getSettingValueByKey('machine_nozzle_tip_outer_diameter')*1000),
'machineNozzleHeadDistance': int(self._settings.getSettingValueByKey('machine_nozzle_head_distance')*1000),
'machineNozzleExpansionAngle': int(self._settings.getSettingValueByKey('machine_nozzle_expansion_angle')),
'wireframePrintspeedBottom': self._settings.getSettingValueByKey('wireframe_printspeed_bottom'),
'wireframePrintspeedUp': self._settings.getSettingValueByKey('wireframe_printspeed_up'),
'wireframePrintspeedDown': self._settings.getSettingValueByKey('wireframe_printspeed_down'),
'wireframePrintspeedFlat': self._settings.getSettingValueByKey('wireframe_printspeed_flat'),
'wireframeFlowConnection': int(self._settings.getSettingValueByKey('wireframe_flow_connection')),
'wireframeFlowFlat': int(self._settings.getSettingValueByKey('wireframe_flow_flat')),
'wireframeTopDelay': int(self._settings.getSettingValueByKey('wireframe_top_delay')*100),
'wireframeBottomDelay': int(self._settings.getSettingValueByKey('wireframe_bottom_delay')*100),
'wireframeFlatDelay': int(self._settings.getSettingValueByKey('wireframe_flat_delay')*100),
'wireframeUpDistHalfSpeed': int(self._settings.getSettingValueByKey('wireframe_up_half_speed')*1000),
'wireframeTopJump': int(self._settings.getSettingValueByKey('wireframe_top_jump')*1000),
'wireframeFallDown': int(self._settings.getSettingValueByKey('wireframe_fall_down')*1000),
'wireframeDragAlong': int(self._settings.getSettingValueByKey('wireframe_drag_along')*1000),
'wireframeStraightBeforeDown': int(self._settings.getSettingValueByKey('wireframe_straight_before_down')),
'wireframeRoofFallDown': int(self._settings.getSettingValueByKey('wireframe_roof_fall_down')*1000),
'wireframeRoofDragAlong': int(self._settings.getSettingValueByKey('wireframe_roof_drag_along')*1000),
'wireframeRoofOuterDelay': int(self._settings.getSettingValueByKey('wireframe_roof_outer_delay')*100),
'wireframeRoofInset': int(self._settings.getSettingValueByKey('wireframe_roof_inset')*1000),
}
wireFrameStrategy = self._settings.getSettingValueByKey('wireframe_strategy')
if wireFrameStrategy == 'Compensate':
settings['wireframeStrategy'] = 0
if wireFrameStrategy == 'Knot':
settings['wireframeStrategy'] = 1
if wireFrameStrategy == 'Retract':
settings['wireframeStrategy'] = 2
gcodeFlavor = self._settings.getSettingValueByKey('machine_gcode_flavor')
if gcodeFlavor == 'UltiGCode':
settings['gcodeFlavor'] = "GCODE_FLAVOR_ULTIGCODE"
elif gcodeFlavor == 'Makerbot':
settings['gcodeFlavor'] = "GCODE_FLAVOR_MAKERBOT"
elif gcodeFlavor == 'BFB':
settings['gcodeFlavor'] = "GCODE_FLAVOR_BFB"
elif gcodeFlavor == 'Mach3':
settings['gcodeFlavor'] = "GCODE_FLAVOR_MACH3"
elif gcodeFlavor == 'Volumetric':
settings['gcodeFlavor'] = "GCODE_FLAVOR_REPRAP_VOLUMATRIC"
else:
settings['gcodeFlavor'] = "GCODE_FLAVOR_REPRAP"
settings['startCode'] = self._settings.getSettingValueByKey('machine_start_gcode')
settings['endCode'] = self._settings.getSettingValueByKey('machine_end_gcode')
#for n in range(1, self._machine.getMaxNozzles()):
n = 1
settings['extruderOffset1.X'] = int(self._settings.getSettingValueByKey('machine_nozzle_offset_x_1') * 1000)
settings['extruderOffset1.Y'] = int(self._settings.getSettingValueByKey('machine_nozzle_offset_y_1') * 1000)
if not self._settings.getSettingValueByKey('machine_center_is_zero'):
settings['position.X'] = int((self._settings.getSettingValueByKey('machine_width') / 2.0) * 1000)
settings['position.Y'] = int((self._settings.getSettingValueByKey('machine_depth') / 2.0) * 1000)
self._center = Vector(self._settings.getSettingValueByKey('machine_width') / 2.0, 0.0, self._settings.getSettingValueByKey('machine_depth') / 2.0)
else:
settings['position.X'] = 0
settings['position.Y'] = 0
self._center = Vector(0.0, 0.0, 0.0)
settings['position.Z'] = 0
msg = Cura_pb2.SettingList()
for key, value in settings.items():
s = msg.settings.add()
s.name = key
s.value = str(value).encode('utf-8')
self._socket.sendMessage(msg)
def _sendSettings_normal(self):
extruder = 0
settings = {
'extruderNr': extruder,
'layerThickness': int(self._settings.getSettingValueByKey('layer_height') * 1000),
'initialLayerThickness': int(self._settings.getSettingValueByKey('layer_height_0') * 1000),
'printTemperature': int(self._settings.getSettingValueByKey('material_print_temperature')),
'bedTemperature': int(self._settings.getSettingValueByKey('material_bed_temperature')),
'filamentDiameter': int(self._settings.getSettingValueByKey('material_diameter') * 1000),
'filamentFlow': int(self._settings.getSettingValueByKey('material_flow')),
'layer0extrusionWidth': int(self._settings.getSettingValueByKey('wall_line_width_0') * 1000),
'extrusionWidth': int(self._settings.getSettingValueByKey('wall_line_width_x') * 1000),
'insetCount': int(self._settings.getSettingValueByKey('wall_line_count')),
'downSkinCount': int(self._settings.getSettingValueByKey('bottom_layers')),
'upSkinCount': int(self._settings.getSettingValueByKey('top_layers')),
'skirtDistance': int(self._settings.getSettingValueByKey('skirt_gap') * 1000),
'skirtLineCount': int(self._settings.getSettingValueByKey('skirt_line_count')),
'skirtMinLength': int(self._settings.getSettingValueByKey('skirt_minimal_length') * 1000),
'retractionAmount': int(self._settings.getSettingValueByKey('retraction_amount') * 1000),
'retractionAmountPrime': int(0 * 1000),
# 'retractionAmountExtruderSwitch': int(fbk('') * 1000),
'retractionSpeed': int(self._settings.getSettingValueByKey('retraction_speed')),
'retractionPrimeSpeed': int(self._settings.getSettingValueByKey('retraction_speed')),
'retractionMinimalDistance': int(self._settings.getSettingValueByKey('retraction_min_travel') * 1000),
'minimalExtrusionBeforeRetraction': int(self._settings.getSettingValueByKey('retraction_minimal_extrusion') * 1000),
'retractionZHop': int(self._settings.getSettingValueByKey('retraction_hop') * 1000),
'enableCombing': 1 if self._settings.getSettingValueByKey('retraction_combing') else 0,
# 'enableOozeShield': int(fbk('') * 1000),
# 'wipeTowerSize': int(fbk('') * 1000),
# 'multiVolumeOverlap': int(fbk('') * 1000),
'initialSpeedupLayers': int(self._settings.getSettingValueByKey('speed_slowdown_layers')),
'initialLayerSpeed': int(self._settings.getSettingValueByKey('speed_layer_0')),
'skirtSpeed': int(self._settings.getSettingValueByKey('skirt_speed')),
'inset0Speed': int(self._settings.getSettingValueByKey('speed_wall_0')),
'insetXSpeed': int(self._settings.getSettingValueByKey('speed_wall_x')),
'supportSpeed': int(self._settings.getSettingValueByKey('speed_support')),
'moveSpeed': int(self._settings.getSettingValueByKey('speed_travel')),
'skinSpeed': int(self._settings.getSettingValueByKey('speed_topbottom')),
'infillOverlap': int(self._settings.getSettingValueByKey('fill_overlap')),
'infillSpeed': int(self._settings.getSettingValueByKey('speed_infill')),
'minimalLayerTime': int(self._settings.getSettingValueByKey('cool_min_layer_time')),
'minimalFeedrate': int(self._settings.getSettingValueByKey('cool_min_speed')),
'coolHeadLift': 1 if self._settings.getSettingValueByKey('cool_lift_head') else 0,
'fanSpeedMin': self._settings.getSettingValueByKey('cool_fan_speed_min'),
'fanSpeedMax': self._settings.getSettingValueByKey('cool_fan_speed_max'),
'fanFullOnLayerNr': self._settings.getSettingValueByKey('cool_fan_full_layer'),
'spiralizeMode': 1 if self._settings.getSettingValueByKey('magic_spiralize') == 'True' else 0,
}
if self._settings.getSettingValueByKey('top_bottom_pattern') == 'Lines':
settings['skinPattern'] = 'SKIN_LINES'
elif self._settings.getSettingValueByKey('top_bottom_pattern') == 'Concentric':
settings['skinPattern'] = 'SKIN_CONCENTRIC'
if self._settings.getSettingValueByKey('fill_pattern') == 'Grid':
settings['infillPattern'] = 'INFILL_GRID'
elif self._settings.getSettingValueByKey('fill_pattern') == 'Triangles': # TODO add option to fdmPrinter.json once it has been translated(?)
settings['infillPattern'] = 'INFILL_TRIANGLES'
elif self._settings.getSettingValueByKey('fill_pattern') == 'Lines':
settings['infillPattern'] = 'INFILL_LINES'
elif self._settings.getSettingValueByKey('fill_pattern') == 'Concentric':
settings['infillPattern'] = 'INFILL_CONCENTRIC'
elif self._settings.getSettingValueByKey('fill_pattern') == 'ZigZag':
settings['infillPattern'] = 'INFILL_ZIGZAG'
adhesion_type = self._settings.getSettingValueByKey('adhesion_type')
if adhesion_type == 'Raft':
settings['raftMargin'] = int(self._settings.getSettingValueByKey('raft_margin') * 1000)
settings['raftLineSpacing'] = int(self._settings.getSettingValueByKey('raft_line_spacing') * 1000)
settings['raftBaseThickness'] = int(self._settings.getSettingValueByKey('raft_base_thickness') * 1000)
settings['raftBaseLinewidth'] = int(self._settings.getSettingValueByKey('raft_base_linewidth') * 1000)
settings['raftBaseSpeed'] = int(self._settings.getSettingValueByKey('raft_base_speed') * 1000)
settings['raftInterfaceThickness'] = int(self._settings.getSettingValueByKey('raft_interface_thickness') * 1000)
settings['raftInterfaceLinewidth'] = int(self._settings.getSettingValueByKey('raft_interface_linewidth') * 1000)
settings['raftInterfaceLineSpacing'] = int(self._settings.getSettingValueByKey('raft_line_spacing') * 1000)
settings['raftFanSpeed'] = 0
settings['raftSurfaceThickness'] = int(self._settings.getSettingValueByKey('layer_height_0') * 1000)
settings['raftSurfaceLinewidth'] = int(self._settings.getSettingValueByKey('wall_line_width_x') * 1000)
settings['raftSurfaceLineSpacing'] = int(self._settings.getSettingValueByKey('wall_line_width_x') * 1000)
settings['raftSurfaceLayers'] = int(self._settings.getSettingValueByKey('raft_surface_layers'))
settings['raftSurfaceSpeed'] = int(self._settings.getSettingValueByKey('speed_layer_0') * 1000)
settings['raftAirGap'] = int(self._settings.getSettingValueByKey('raft_airgap') * 1000)
settings['skirtLineCount'] = 0
pass
elif adhesion_type == 'Brim':
settings['skirtDistance'] = 0
settings['skirtLineCount'] = self._settings.getSettingValueByKey('brim_line_count')
if self._settings.getSettingValueByKey('support_type') == 'None':
settings['supportType'] = ''
settings['supportAngle'] = -1
else:
settings['supportAngle'] = self._settings.getSettingValueByKey('support_angle')
settings['supportOnBuildplateOnly'] = 1 if self._settings.getSettingValueByKey('support_type') == 'Touching Buildplate' else 0
settings['supportLineDistance'] = int(100 * self._settings.getSettingValueByKey('wall_line_width_x') * 1000 / self._settings.getSettingValueByKey('support_fill_rate'))
settings['supportXYDistance'] = int(self._settings.getSettingValueByKey('support_xy_distance') * 1000)
settings['supportZDistance'] = int(self._settings.getSettingValueByKey('support_z_distance') * 1000)
settings['supportZDistanceBottom'] = int(self._settings.getSettingValueByKey('support_top_distance') * 1000)
settings['supportZDistanceTop'] = int(self._settings.getSettingValueByKey('support_bottom_distance') * 1000)
settings['supportJoinDistance'] = int(self._settings.getSettingValueByKey('support_join_distance') * 1000)
settings['supportAreaSmoothing'] = int(self._settings.getSettingValueByKey('support_area_smoothing') * 1000)
settings['supportMinimalAreaSqrt'] = int(self._settings.getSettingValueByKey('support_minimal_diameter') * 1000) if self._settings.getSettingValueByKey('support_use_towers') else 0
settings['supportTowerDiameter'] = int(self._settings.getSettingValueByKey('support_tower_diameter') * 1000)
settings['supportTowerRoofAngle'] = int(self._settings.getSettingValueByKey('support_tower_roof_angle'))
settings['supportConnectZigZags'] = 1 if self._settings.getSettingValueByKey('support_connect_zigzags') else 0
settings['supportExtruder'] = -1 #Not yet implemented
if self._settings.getSettingValueByKey('support_pattern') == 'Grid':
settings['supportType'] = 'GRID'
elif self._settings.getSettingValueByKey('support_pattern') == 'Lines':
settings['supportType'] = 'LINES'
elif self._settings.getSettingValueByKey('support_pattern') == 'ZigZag':
settings['supportType'] = 'ZIGZAG'
settings['sparseInfillLineDistance'] = -1
if self._settings.getSettingValueByKey('fill_sparse_density') >= 100:
settings['sparseInfillLineDistance'] = self._settings.getSettingValueByKey('wall_line_width_x')
settings['downSkinCount'] = 10000
settings['upSkinCount'] = 10000
elif self._settings.getSettingValueByKey('fill_sparse_density') > 0:
settings['sparseInfillLineDistance'] = int(100 * self._settings.getSettingValueByKey('wall_line_width_x') * 1000 / self._settings.getSettingValueByKey('fill_sparse_density'))
settings['sparseInfillCombineCount'] = int(round(self._settings.getSettingValueByKey('fill_sparse_combine')))
gcodeFlavor = self._settings.getSettingValueByKey('machine_gcode_flavor')
if gcodeFlavor == 'UltiGCode':
settings['gcodeFlavor'] = "GCODE_FLAVOR_ULTIGCODE"
elif gcodeFlavor == 'Makerbot':
settings['gcodeFlavor'] = "GCODE_FLAVOR_MAKERBOT"
elif gcodeFlavor == 'BFB':
settings['gcodeFlavor'] = "GCODE_FLAVOR_BFB"
elif gcodeFlavor == 'Mach3':
settings['gcodeFlavor'] = "GCODE_FLAVOR_MACH3"
elif gcodeFlavor == 'Volumetric':
settings['gcodeFlavor'] = "GCODE_FLAVOR_REPRAP_VOLUMATRIC"
else:
settings['gcodeFlavor'] = "GCODE_FLAVOR_REPRAP"
settings['startCode'] = self._settings.getSettingValueByKey('machine_start_gcode')
settings['endCode'] = self._settings.getSettingValueByKey('machine_end_gcode')
#for n in range(1, self._machine.getMaxNozzles()):
n = 1
settings['extruderOffset1.X'] = int(self._settings.getSettingValueByKey('machine_nozzle_offset_x_1') * 1000)
settings['extruderOffset1.Y'] = int(self._settings.getSettingValueByKey('machine_nozzle_offset_y_1') * 1000)
if not self._settings.getSettingValueByKey('machine_center_is_zero'):
settings['position.X'] = int((self._settings.getSettingValueByKey('machine_width') / 2.0) * 1000)
settings['position.Y'] = int((self._settings.getSettingValueByKey('machine_depth') / 2.0) * 1000)
self._center = Vector(self._settings.getSettingValueByKey('machine_width') / 2.0, 0.0, self._settings.getSettingValueByKey('machine_depth') / 2.0)
else:
settings['position.X'] = 0
settings['position.Y'] = 0
self._center = Vector(0.0, 0.0, 0.0)
settings['position.Z'] = 0
msg = Cura_pb2.SettingList()
for key, value in settings.items():
s = msg.settings.add()
s.name = key
s.value = str(value).encode('utf-8')
self._socket.sendMessage(msg)
def _onBackendConnected(self):
if self._restart:
self._onChanged()
self._restart = False