Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactored handling of power devices and printer status (#81) #87

Merged
merged 1 commit into from
May 9, 2024
+42 −82
Merged

refactored handling of power devices and printer status (#81) #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 40 additions & 80 deletions MoonrakerConnection/MoonrakerOutputDevice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ def updateConfig(self, config: dict = None) -> None:
self._apiKey = self._config.get("api_key", "").strip()
self._powerDevice = self._config.get("power_device", "").strip()
self._retryInterval = self._config.get("retry_interval", "").strip()
self._frontendUrl = self._config.get("frontend_url", self._url).strip()
self._frontendUrl = self._config.get("frontend_url", "").strip()
self._outputFormat = self._config.get("output_format", "gcode")
if self._outputFormat and self._outputFormat != "ufp":
self._outputFormat = "gcode"
Expand Down Expand Up @@ -205,7 +205,7 @@ def _resetState(self) -> None:
self._fileName = None
self._startPrint = None
self._postData = None
self._timeoutCounter = 0
self._errorCounter = 0
self._stage = OutputStage.Ready

def _onUploadFilenameChanged(self) -> None:
Expand Down Expand Up @@ -266,66 +266,46 @@ def _onUploadFilenameAccepted(self) -> None:
self._getPrinterStatus()

def _getPowerDeviceStatus(self) -> None:
powerDevice = self._powerDevice
if "," in powerDevice:
powerDevices = [x.strip() for x in powerDevice.split(',')]
powerDevice = powerDevices[0]

# only check first power device
powerDevice = [x.strip() for x in self._powerDevice.split(',')][0]
Logger.log("d", "Checking printer device [power {}] status.".format(powerDevice))

self._sendRequest('machine/device_power/device?device={}'.format(powerDevice), on_success = self._checkPowerDeviceStatus)

def _checkPowerDeviceStatus(self, reply: QNetworkReply) -> None:
response = self._getResponse(reply)
powerDevice = self._powerDevice
if "," in powerDevice:
powerDevices = [x.strip() for x in powerDevice.split(',')]
powerDevice = powerDevices[0]

powerDevicesStatus = response['result'][powerDevice]
logMessage = "Power device [power {}] status == '{}'; startPrint is {} => ".format(powerDevice, powerDevicesStatus, self._startPrint)

if powerDevicesStatus == 'on':
Logger.log("d", logMessage + "Calling _getPrinterStatus()")
powerDevice = list(response['result'].keys())[0]
powerDeviceStatus = list(response['result'].values())[0]
logMessage = "Power device [power {}] status == '{}'; startPrint is {} => ".format(powerDevice, powerDeviceStatus, self._startPrint)

# only turn on power device if start print job is requested
if self._startPrint and powerDeviceStatus == 'off':
Logger.log("d", logMessage + "Calling _turnPowerDeviceOn() - turn on power device.")
self._turnPowerDeviceOn()
else:
Logger.log("d", logMessage + "Calling _getPrinterStatus() - override status of power device (only upload file).")
self._getPrinterStatus()
elif powerDevicesStatus == 'off':
if self._startPrint:
Logger.log("d", logMessage + "Calling _turnPowerDeviceOn()")
self._turnPowerDeviceOn()
else:
Logger.log("d", logMessage + "Sending FIRMWARE_RESTART before calling _getPrinterStatus().")
self._sendRequest('printer/firmware_restart', data = json.dumps({}).encode(), dataIsJSON = True, on_success = self._getPrinterStatus)

def _turnPowerDeviceOn(self) -> None:
powerDevice = self._powerDevice
if "," in powerDevice:
powerDevices = [x.strip() for x in powerDevice.split(',')]
for powerDevice in powerDevices:
Logger.log("i", "Turning on Moonraker power device [power {}].".format(powerDevice))
self._sendRequest('machine/device_power/device?' + urllib.parse.urlencode({'device': powerDevice, 'action': 'on'}), data = '{}'.encode(), dataIsJSON = True, on_success = self._getPrinterStatus)
else:
Logger.log("i", "Turning on (single) Moonraker power device [power {}].".format(powerDevice))
self._sendRequest('machine/device_power/device?' + urllib.parse.urlencode({'device': powerDevice, 'action': 'on'}), data = '{}'.encode(), dataIsJSON = True, on_success = self._getPrinterStatus)
for index, powerDevice in enumerate([x.strip() for x in self._powerDevice.split(',')]):
Logger.log("i", "Turning on Moonraker power device [power {}].".format(powerDevice))
# on_success-callback: track the status of the printer only through the first powerDevice for the subsequent flow
self._sendRequest('machine/device_power/device?' + urllib.parse.urlencode({'device': powerDevice, 'action': 'on'}), data = '{}'.encode(), dataIsJSON = True, on_success = self._getPrinterStatus if index == 0 else None)

def _getPrinterStatus(self, reply: QNetworkReply = None) -> None:
self._sendRequest('printer/info', on_success = self._checkPrinterStatus, on_error = self._onPrinterError)

def _checkPrinterStatus(self, reply: QNetworkReply) -> None:
response = self._getResponse(reply)
status = response['result']['state']
message = response['result']['state_message']

if self._startPrint:
if status == 'ready':
# printer is online
self._onPrinterOnline(reply)
else:
# printer is not ready
self._onPrinterError()
elif status != 'error':
# moonraker can queue job
if self._startPrint and status == 'ready' or not self._startPrint and status != 'error':
# status == 'ready' => printer is online || status != 'error' => upload possible
self._onPrinterOnline(reply)
else:
# set counter to max before call?
self._onPrinterError()
# printer is not ready => increase timeoutCounter
self._onPrinterError(reply, "The status of the printer is '{}'.\n\n{}".format(status, message.strip()))

def _onPrinterOnline(self, reply: QNetworkReply) -> None:
# remove connection timeout message
Expand All @@ -342,7 +322,7 @@ def _onPrinterOnline(self, reply: QNetworkReply) -> None:
return # never gets here now?
if reply.error() != NoError: # QNetworkReply.NetworkError.NoError // 0
Logger.log("e", "Stopping due to reply error: {}.".format(reply.error()))
self._onRequestError(reply)
self._onError(reply)
return

Logger.log("i", "Uploading file '{}' [format: {}].".format(self._fileName, self._outputFormat))
Expand All @@ -355,27 +335,9 @@ def _onPrinterOnline(self, reply: QNetworkReply) -> None:
self._sendRequest('server/files/upload', name = self._fileName, data = self._postData, on_success = self._onFileUploaded)

def _onPrinterError(self, reply: QNetworkReply = None, error = None) -> None:
self._timeoutCounter += 1
maxTimeoutCounterValue = 20

if self._timeoutCounter > maxTimeoutCounterValue:
messageText = "Error: Connection to Moonraker at {} timed out.".format(self._url)
self._message.setLifetimeTimer(0)
self._message.setText(messageText)
self._message.setTitle("Moonraker - Error")

browseMessageText = "Check your Moonraker and Klipper settings."
browseMessageText += "\nA FIRMWARE_RESTART may be necessary."
if self._powerDevice:
browseMessageText += "\nAlso check [power {}] in moonraker.conf".format(self._powerDevice)

self._message = Message(catalog.i18nc("@info:status", browseMessageText), 0, False)
self._message.addAction("open_browser", catalog.i18nc("@action:button", "Open Browser"), "globe", catalog.i18nc("@info:tooltip", "Open browser to Moonraker."))
self._message.actionTriggered.connect(self._onMessageActionTriggered)
self._message.show()

self.writeError.emit(self)
self._resetState()
self._errorCounter += 1
if self._errorCounter > 20:
self._onError(reply, error)
else:
try:
sleep(float(self._retryInterval))
Expand All @@ -390,7 +352,7 @@ def _onFileUploaded(self, reply: QNetworkReply) -> None:
return
if reply.error() != NoError: # QNetworkReply.NetworkError.NoError // 0
Logger.log("e", "Stopping due to reply error: {}.".format(reply.error()))
self._onRequestError(reply)
self._onError(reply)
return

Logger.log("i", "Upload completed.")
Expand All @@ -400,11 +362,7 @@ def _onFileUploaded(self, reply: QNetworkReply) -> None:
if self._message:
self._message.hide()
self._message = None
messageText = "Upload of '{}' to {} successfully completed"
if self._startPrint:
messageText += " and print job initialized."
else:
messageText += "."
messageText = "Upload of '{}' to {} successfully completed" + (" and print job initialized." if self._startPrint else ".")
self._message = Message(catalog.i18nc("@info:status", messageText.format(os.path.basename(self._fileName), self._name)), 30 if self._uploadAutohideMessagebox else 0, True)
self._message.setTitle("Moonraker")
self._message.addAction("open_browser", catalog.i18nc("@action:button", "Open Browser"), "globe", catalog.i18nc("@info:tooltip", "Open browser to Moonraker."))
Expand All @@ -416,7 +374,7 @@ def _onFileUploaded(self, reply: QNetworkReply) -> None:

def _onMessageActionTriggered(self, message: Message, action: str) -> None:
if action == "open_browser":
QDesktopServices.openUrl(QUrl(self._frontendUrl))
QDesktopServices.openUrl(QUrl(self._frontendUrl if self._frontendUrl else self._url))
if self._message:
self._message.hide()
self._message = None
Expand All @@ -427,8 +385,9 @@ def _getResponse(self, reply: QNetworkReply):
try:
response = json.loads(str(byte_string, 'utf-8'))
except json.JSONDecodeError:
Logger.log("e", "Reply is not a JSON: %s" % str(byte_string, 'utf-8'))
self._onPrinterError()
message = "JSONDecodeError occurred - NetworkReply is not a JSON: %s" % str(byte_string, 'utf-8')
Logger.log("e", message)
self._onPrinterError(reply, message)

return response

Expand Down Expand Up @@ -470,9 +429,9 @@ def _sendRequest(self, path: str, name: str = None, data: QByteArray = None, dat
# postData is JSON
headers['Content-Type'] = 'application/json'

requestManager.post(url, headers, postData, callback = on_success, error_callback = on_error if on_error else self._onRequestError, upload_progress_callback = self._onUploadProgress if not dataIsJSON else None)
requestManager.post(url, headers, postData, callback = on_success, error_callback = on_error if on_error else self._onError, upload_progress_callback = self._onUploadProgress if not dataIsJSON else None)
else:
requestManager.get(url, headers, callback = on_success, error_callback = on_error if on_error else self._onRequestError)
requestManager.get(url, headers, callback = on_success, error_callback = on_error if on_error else self._onError)

def _onUploadProgress(self, bytesSent, bytesTotal) -> None:
if bytesTotal > 0:
Expand All @@ -481,18 +440,19 @@ def _onUploadProgress(self, bytesSent, bytesTotal) -> None:
self._message.setProgress(progress)
self.writeProgress.emit(self, progress)

def _onRequestError(self, reply: QNetworkReply, error) -> None:
def _onError(self, reply: QNetworkReply, error) -> None:
Logger.log("e", repr(error))
if self._message:
self._message.hide()
self._message = None

message = Message(catalog.i18nc("@info:status", "There was a network error: {} {}").format(error, reply.errorString() if reply else ""), 0, False)
messageText = "Uploading to Moonraker at {} was not successful.\n\n{} {}".format(self._url, error, ("- " + reply.errorString()) if reply else "")
message = Message(catalog.i18nc("@info:status", messageText.strip()), 0, False)
message.setTitle("Moonraker - Error")
message.show()

self.writeError.emit(self)
self._resetState()

def _getConnectMessage(self):
return "Connecting to Moonraker at {} {}".format(self._url, spinner[self._timeoutCounter % len(spinner)])
return "Connecting to Moonraker at {} {}".format(self._url, spinner[self._errorCounter % len(spinner)])
4 changes: 2 additions & 2 deletions MoonrakerConnection/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"name": "Klipper/Moonraker Connection",
"author": "emtrax",
"description": "Upload and Print with Klipper via Moonraker API.",
"version": "1.7.2",
"supported_sdk_versions": ["7.3.0", "7.4.0", "7.5.0", "7.6.0", "7.7.0", "7.8.0", "7.9.0", "8.0.0", "8.1.0", "8.2.0", "8.3.0", "8.4.0"]
"version": "1.8.0",
"supported_sdk_versions": ["7.3.0", "7.4.0", "7.5.0", "7.6.0", "7.7.0", "7.8.0", "7.9.0", "8.0.0", "8.1.0", "8.2.0", "8.3.0", "8.4.0", "8.5.0", "8.6.0"]
}