558 lines
15 KiB
Python
558 lines
15 KiB
Python
# coding=utf-8
|
|
__author__ = "Gina Häußge <osd@foosel.net>"
|
|
__license__ = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'
|
|
|
|
import time
|
|
from threading import Thread, Event, Lock
|
|
|
|
import printer_webui.util.comm as comm
|
|
from printer_webui.util import gcodeInterpreter
|
|
|
|
from printer_webui.settings import settings
|
|
|
|
def getConnectionOptions():
|
|
"""
|
|
Retrieves the available ports, baudrates, prefered port and baudrate for connecting to the printer.
|
|
"""
|
|
return {
|
|
"ports": comm.serialList(),
|
|
"baudrates": comm.baudrateList(),
|
|
"portPreference": settings().get("serial", "port"),
|
|
"baudratePreference": settings().getInt("serial", "baudrate")
|
|
}
|
|
|
|
class Printer():
|
|
def __init__(self):
|
|
# state
|
|
self._temp = None
|
|
self._bedTemp = None
|
|
self._targetTemp = None
|
|
self._targetBedTemp = None
|
|
self._temps = {
|
|
"actual": [],
|
|
"target": [],
|
|
"actualBed": [],
|
|
"targetBed": []
|
|
}
|
|
self._tempBacklog = []
|
|
|
|
self._latestMessage = None
|
|
self._messages = []
|
|
self._messageBacklog = []
|
|
|
|
self._latestLog = None
|
|
self._log = []
|
|
self._logBacklog = []
|
|
|
|
self._state = None
|
|
|
|
self._currentZ = None
|
|
|
|
self._progress = None
|
|
self._printTime = None
|
|
self._printTimeLeft = None
|
|
|
|
# gcode handling
|
|
self._gcode = None
|
|
self._gcodeList = None
|
|
self._filename = None
|
|
self._gcodeLoader = None
|
|
|
|
# feedrate
|
|
self._feedrateModifierMapping = {"outerWall": "WALL-OUTER", "innerWall": "WALL_INNER", "fill": "FILL", "support": "SUPPORT"}
|
|
|
|
# timelapse
|
|
self._timelapse = None
|
|
|
|
# comm
|
|
self._comm = None
|
|
|
|
# callbacks
|
|
self._callbacks = []
|
|
self._lastProgressReport = None
|
|
|
|
self._stateMonitor = StateMonitor(ratelimit=0.5, updateCallback=self._sendCurrentDataCallbacks)
|
|
self._stateMonitor.reset(
|
|
state={"state": self._state, "stateString": self.getStateString(), "flags": self._getStateFlags()}
|
|
)
|
|
|
|
#~~ callback handling
|
|
|
|
def registerCallback(self, callback):
|
|
self._callbacks.append(callback)
|
|
self._sendInitialStateUpdate(callback)
|
|
|
|
def unregisterCallback(self, callback):
|
|
if callback in self._callbacks:
|
|
self._callbacks.remove(callback)
|
|
|
|
def _sendCurrentDataCallbacks(self, data):
|
|
for callback in self._callbacks:
|
|
try: callback.sendCurrentData(data)
|
|
except: pass
|
|
|
|
#~~ printer commands
|
|
|
|
def connect(self, port=None, baudrate=None):
|
|
"""
|
|
Connects to the printer. If port and/or baudrate is provided, uses these settings, otherwise autodetection
|
|
will be attempted.
|
|
"""
|
|
if self._comm is not None:
|
|
self._comm.close()
|
|
self._comm = comm.MachineCom(port, baudrate, callbackObject=self)
|
|
|
|
def disconnect(self):
|
|
"""
|
|
Closes the connection to the printer.
|
|
"""
|
|
if self._comm is not None:
|
|
self._comm.close()
|
|
self._comm = None
|
|
|
|
def command(self, command):
|
|
"""
|
|
Sends a single gcode command to the printer.
|
|
"""
|
|
self.commands([command])
|
|
|
|
def commands(self, commands):
|
|
"""
|
|
Sends multiple gcode commands (provided as a list) to the printer.
|
|
"""
|
|
for command in commands:
|
|
self._comm.sendCommand(command)
|
|
|
|
def setFeedrateModifier(self, structure, percentage):
|
|
if (not self._feedrateModifierMapping.has_key(structure)) or percentage < 0:
|
|
return
|
|
|
|
self._comm.setFeedrateModifier(self._feedrateModifierMapping[structure], percentage / 100.0)
|
|
|
|
def loadGcode(self, file):
|
|
"""
|
|
Loads the gcode from the given file as the new print job.
|
|
Aborts if the printer is currently printing or another gcode file is currently being loaded.
|
|
"""
|
|
if (self._comm is not None and self._comm.isPrinting()) or (self._gcodeLoader is not None):
|
|
return
|
|
|
|
self._setJobData(None, None, None)
|
|
|
|
self._gcodeLoader = GcodeLoader(file, self)
|
|
self._gcodeLoader.start()
|
|
|
|
def startPrint(self):
|
|
"""
|
|
Starts the currently loaded print job.
|
|
Only starts if the printer is connected and operational, not currently printing and a printjob is loaded
|
|
"""
|
|
if self._comm is None or not self._comm.isOperational():
|
|
return
|
|
if self._gcodeList is None:
|
|
return
|
|
if self._comm.isPrinting():
|
|
return
|
|
|
|
self._setCurrentZ(-1)
|
|
self._comm.printGCode(self._gcodeList)
|
|
|
|
def togglePausePrint(self):
|
|
"""
|
|
Pause the current printjob.
|
|
"""
|
|
if self._comm is None:
|
|
return
|
|
self._comm.setPause(not self._comm.isPaused())
|
|
|
|
def cancelPrint(self, disableMotorsAndHeater=True):
|
|
"""
|
|
Cancel the current printjob.
|
|
"""
|
|
if self._comm is None:
|
|
return
|
|
self._comm.cancelPrint()
|
|
if disableMotorsAndHeater:
|
|
self.commands(["M84", "M104 S0", "M140 S0"]) # disable motors, switch off heaters
|
|
|
|
# reset line, height, print time
|
|
self._setCurrentZ(None)
|
|
self._setProgressData(None, None, None)
|
|
|
|
#~~ state monitoring
|
|
|
|
def setTimelapse(self, timelapse):
|
|
if self._timelapse is not None and self.isPrinting():
|
|
self._timelapse.onPrintjobStopped()
|
|
del self._timelapse
|
|
self._timelapse = timelapse
|
|
|
|
def getTimelapse(self):
|
|
return self._timelapse
|
|
|
|
def _setCurrentZ(self, currentZ):
|
|
self._currentZ = currentZ
|
|
self._stateMonitor.setCurrentZ(self._currentZ)
|
|
|
|
def _setState(self, state):
|
|
self._state = state
|
|
self._stateMonitor.setState({"state": self._state, "stateString": self.getStateString(), "stateFlags": self._getStateFlags()})
|
|
|
|
def _addLog(self, log):
|
|
self._log.append(log)
|
|
self._log = self._log[-300:]
|
|
self._stateMonitor.addLog(log)
|
|
|
|
def _addMessage(self, message):
|
|
self._messages.append(message)
|
|
self._messages = self._messages[-300:]
|
|
self._stateMonitor.addMessage(message)
|
|
|
|
def _setProgressData(self, progress, printTime, printTimeLeft):
|
|
self._progress = progress
|
|
self._printTime = printTime
|
|
self._printTimeLeft = printTimeLeft
|
|
self._stateMonitor.setProgress({"progress": self._progress, "printTime": self._printTime, "printTimeLeft": self._printTimeLeft})
|
|
|
|
def _addTemperatureData(self, temp, bedTemp, targetTemp, bedTargetTemp):
|
|
currentTime = int(time.time() * 1000)
|
|
|
|
self._temps["actual"].append((currentTime, temp))
|
|
self._temps["actual"] = self._temps["actual"][-300:]
|
|
|
|
self._temps["target"].append((currentTime, targetTemp))
|
|
self._temps["target"] = self._temps["target"][-300:]
|
|
|
|
self._temps["actualBed"].append((currentTime, bedTemp))
|
|
self._temps["actualBed"] = self._temps["actualBed"][-300:]
|
|
|
|
self._temps["targetBed"].append((currentTime, bedTargetTemp))
|
|
self._temps["targetBed"] = self._temps["targetBed"][-300:]
|
|
|
|
self._temp = temp
|
|
self._bedTemp = bedTemp
|
|
self._targetTemp = targetTemp
|
|
self._targetBedTemp = bedTargetTemp
|
|
|
|
self._stateMonitor.addTemperature({"currentTime": currentTime, "temp": self._temp, "bedTemp": self._bedTemp, "targetTemp": self._targetTemp, "targetBedTemp": self._targetBedTemp})
|
|
|
|
def _setJobData(self, filename, gcode, gcodeList):
|
|
self._filename = filename
|
|
self._gcode = gcode
|
|
self._gcodeList = gcodeList
|
|
|
|
lines = None
|
|
if self._gcodeList:
|
|
lines = len(self._gcodeList)
|
|
|
|
estimatedPrintTime = None
|
|
filament = None
|
|
if self._gcode:
|
|
estimatedPrintTime = self._gcode.totalMoveTimeMinute
|
|
filament = self._gcode.extrusionAmount
|
|
|
|
self._stateMonitor.setJobData({"filename": self._filename, "lines": lines, "estimatedPrintTime": estimatedPrintTime, "filament": filament})
|
|
|
|
def _sendInitialStateUpdate(self, callback):
|
|
lines = None
|
|
if self._gcodeList:
|
|
lines = len(self._gcodeList)
|
|
|
|
estimatedPrintTime = None
|
|
filament = None
|
|
if self._gcode:
|
|
estimatedPrintTime = self._gcode.totalMoveTimeMinute
|
|
filament = self._gcode.extrusionAmount
|
|
|
|
try:
|
|
data = self._stateMonitor.getCurrentData()
|
|
data.update({
|
|
"temperatureHistory": self._temps,
|
|
"logHistory": self._log,
|
|
"messageHistory": self._messages
|
|
})
|
|
callback.sendHistoryData(data)
|
|
except Exception, err:
|
|
import sys
|
|
sys.stderr.write("ERROR: %s\n" % str(err))
|
|
pass
|
|
|
|
def _getStateFlags(self):
|
|
return {
|
|
"operational": self.isOperational(),
|
|
"printing": self.isPrinting(),
|
|
"closedOrError": self.isClosedOrError(),
|
|
"error": self.isError(),
|
|
"loading": self.isLoading(),
|
|
"paused": self.isPaused(),
|
|
"ready": self.isReady()
|
|
}
|
|
|
|
#~~ callbacks triggered from self._comm
|
|
|
|
def mcLog(self, message):
|
|
"""
|
|
Callback method for the comm object, called upon log output.
|
|
"""
|
|
self._addLog(message)
|
|
|
|
def mcTempUpdate(self, temp, bedTemp, targetTemp, bedTargetTemp):
|
|
self._addTemperatureData(temp, bedTemp, targetTemp, bedTargetTemp)
|
|
|
|
def mcStateChange(self, state):
|
|
"""
|
|
Callback method for the comm object, called if the connection state changes.
|
|
"""
|
|
oldState = self._state
|
|
|
|
if self._timelapse is not None:
|
|
if oldState == self._comm.STATE_PRINTING:
|
|
self._timelapse.onPrintjobStopped()
|
|
elif state == self._comm.STATE_PRINTING:
|
|
self._timelapse.onPrintjobStarted(self._filename)
|
|
|
|
self._setState(state)
|
|
|
|
|
|
def mcMessage(self, message):
|
|
"""
|
|
Callback method for the comm object, called upon message exchanges via serial.
|
|
Stores the message in the message buffer, truncates buffer to the last 300 lines.
|
|
"""
|
|
self._addMessage(message)
|
|
|
|
def mcProgress(self, lineNr):
|
|
"""
|
|
Callback method for the comm object, called upon any change in progress of the printjob.
|
|
Triggers storage of new values for printTime, printTimeLeft and the current line.
|
|
"""
|
|
oldProgress = self._progress
|
|
|
|
if self._timelapse is not None:
|
|
try: self._timelapse.onPrintjobProgress(oldProgress, self._progress, int(round(self._progress * 100 / len(self._gcodeList))))
|
|
except: pass
|
|
|
|
self._setProgressData(self._comm.getPrintPos(), self._comm.getPrintTime(), self._comm.getPrintTimeRemainingEstimate())
|
|
|
|
def mcZChange(self, newZ):
|
|
"""
|
|
Callback method for the comm object, called upon change of the z-layer.
|
|
"""
|
|
oldZ = self._currentZ
|
|
if self._timelapse is not None:
|
|
self._timelapse.onZChange(oldZ, newZ)
|
|
|
|
self._setCurrentZ(newZ)
|
|
|
|
#~~ callbacks triggered by gcodeLoader
|
|
|
|
def onGcodeLoadingProgress(self, progress):
|
|
self._stateMonitor.setGcodeData({"filename": self._gcodeLoader._filename, "progress": progress})
|
|
|
|
def onGcodeLoaded(self):
|
|
self._setJobData(self._gcodeLoader._filename, self._gcodeLoader._gcode, self._gcodeLoader._gcodeList)
|
|
self._setCurrentZ(None)
|
|
self._setProgressData(None, None, None)
|
|
self._gcodeLoader = None
|
|
|
|
self._stateMonitor.setState({"state": self._state, "stateString": self.getStateString(), "stateFlags": self._getStateFlags()})
|
|
|
|
#~~ state reports
|
|
|
|
def feedrateState(self):
|
|
if self._comm is not None:
|
|
feedrateModifiers = self._comm.getFeedrateModifiers()
|
|
result = {}
|
|
for structure in self._feedrateModifierMapping.keys():
|
|
if (feedrateModifiers.has_key(self._feedrateModifierMapping[structure])):
|
|
result[structure] = int(round(feedrateModifiers[self._feedrateModifierMapping[structure]] * 100))
|
|
else:
|
|
result[structure] = 100
|
|
return result
|
|
else:
|
|
return None
|
|
|
|
def getStateString(self):
|
|
"""
|
|
Returns a human readable string corresponding to the current communication state.
|
|
"""
|
|
if self._comm is None:
|
|
return "Offline"
|
|
else:
|
|
return self._comm.getStateString()
|
|
|
|
def isClosedOrError(self):
|
|
return self._comm is None or self._comm.isClosedOrError()
|
|
|
|
def isOperational(self):
|
|
return self._comm is not None and self._comm.isOperational()
|
|
|
|
def isPrinting(self):
|
|
return self._comm is not None and self._comm.isPrinting()
|
|
|
|
def isPaused(self):
|
|
return self._comm is not None and self._comm.isPaused()
|
|
|
|
def isError(self):
|
|
return self._comm is not None and self._comm.isError()
|
|
|
|
def isReady(self):
|
|
return self._gcodeLoader is None and self._gcodeList and len(self._gcodeList) > 0
|
|
|
|
def isLoading(self):
|
|
return self._gcodeLoader is not None
|
|
|
|
class GcodeLoader(Thread):
|
|
"""
|
|
The GcodeLoader takes care of loading a gcode-File from disk and parsing it into a gcode object in a separate
|
|
thread while constantly notifying interested listeners about the current progress.
|
|
The progress is returned as a float value between 0 and 1 which is to be interpreted as the percentage of completion.
|
|
"""
|
|
|
|
def __init__(self, filename, printerCallback):
|
|
Thread.__init__(self)
|
|
|
|
self._printerCallback = printerCallback
|
|
|
|
self._filename = filename
|
|
self._progress = None
|
|
|
|
self._gcode = None
|
|
self._gcodeList = None
|
|
|
|
def run(self):
|
|
#Send an initial M110 to reset the line counter to zero.
|
|
prevLineType = lineType = "CUSTOM"
|
|
gcodeList = ["M110"]
|
|
with open(self._filename, "r") as file:
|
|
for line in file:
|
|
if line.startswith(";TYPE:"):
|
|
lineType = line[6:].strip()
|
|
if ";" in line:
|
|
line = line[0:line.find(";")]
|
|
line = line.strip()
|
|
if len(line) > 0:
|
|
if prevLineType != lineType:
|
|
gcodeList.append((line, lineType, ))
|
|
else:
|
|
gcodeList.append(line)
|
|
prevLineType = lineType
|
|
|
|
self._gcodeList = gcodeList
|
|
self._gcode = gcodeInterpreter.gcode()
|
|
self._gcode.progressCallback = self.onProgress
|
|
self._gcode.loadList(self._gcodeList)
|
|
|
|
self._printerCallback.onGcodeLoaded()
|
|
|
|
def onProgress(self, progress):
|
|
self._progress = progress
|
|
self._printerCallback.onGcodeLoadingProgress(progress)
|
|
|
|
class PrinterCallback(object):
|
|
def sendCurrentData(self, data):
|
|
pass
|
|
|
|
def sendHistoryData(self, data):
|
|
pass
|
|
|
|
class StateMonitor(object):
|
|
def __init__(self, ratelimit, updateCallback):
|
|
self._ratelimit = ratelimit
|
|
self._updateCallback = updateCallback
|
|
|
|
self._state = None
|
|
self._jobData = None
|
|
self._gcodeData = None
|
|
self._currentZ = None
|
|
self._progress = None
|
|
self._logBacklog = []
|
|
self._logHistory = []
|
|
self._messageBacklog = []
|
|
self._messageHistory = []
|
|
self._temperatureBacklog = []
|
|
self._temperatureHistory = []
|
|
|
|
self._temperatureBacklogMutex = Lock()
|
|
self._logBacklogMutex = Lock()
|
|
self._messageBacklogMutex = Lock()
|
|
self._changeEvent = Event()
|
|
|
|
self._lastUpdate = time.time()
|
|
self._worker = Thread(target=self._work)
|
|
self._worker.start()
|
|
|
|
def reset(self, state=None):
|
|
self.setState(state)
|
|
|
|
def addTemperature(self, temperature):
|
|
with self._temperatureBacklogMutex:
|
|
self._temperatureBacklog.append(temperature)
|
|
self._changeEvent.set()
|
|
|
|
def addLog(self, log):
|
|
with self._logBacklogMutex:
|
|
self._logBacklog.append(log)
|
|
self._changeEvent.set()
|
|
|
|
def addMessage(self, message):
|
|
with self._messageBacklogMutex:
|
|
self._messageBacklog.append(message)
|
|
self._changeEvent.set()
|
|
|
|
def setCurrentZ(self, currentZ):
|
|
self._currentZ = currentZ
|
|
self._changeEvent.set()
|
|
|
|
def setState(self, state):
|
|
self._state = state
|
|
self._changeEvent.set()
|
|
|
|
def setJobData(self, jobData):
|
|
self._jobData = jobData
|
|
self._changeEvent.set()
|
|
|
|
def setGcodeData(self, gcodeData):
|
|
self._gcodeData = gcodeData
|
|
self._changeEvent.set()
|
|
|
|
def setProgress(self, progress):
|
|
self._progress = progress
|
|
self._changeEvent.set()
|
|
|
|
def _work(self):
|
|
while True:
|
|
self._changeEvent.wait()
|
|
additionalWaitTime = time.time() + self._ratelimit - self._lastUpdate
|
|
if additionalWaitTime > 0:
|
|
time.sleep(additionalWaitTime)
|
|
|
|
with self._temperatureBacklogMutex:
|
|
temperatures = self._temperatureBacklog
|
|
self._temperatureBacklog = []
|
|
|
|
with self._logBacklogMutex:
|
|
logs = self._logBacklog
|
|
self._logBacklog = []
|
|
|
|
with self._messageBacklogMutex:
|
|
messages = self._messageBacklog
|
|
self._messageBacklog = []
|
|
|
|
data = self.getCurrentData()
|
|
data.update({
|
|
"temperatures": temperatures,
|
|
"logs": logs,
|
|
"messages": messages
|
|
})
|
|
self._updateCallback(data)
|
|
self._lastUpdate = time.time()
|
|
self._changeEvent.clear()
|
|
|
|
def getCurrentData(self):
|
|
return {
|
|
"state": self._state,
|
|
"job": self._jobData,
|
|
"gcode": self._gcodeData,
|
|
"currentZ": self._currentZ
|
|
}
|