Linux PyQt tray application to control OctoPrint instances
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

octotray.py 42KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172
  1. #!/usr/bin/env python3
  2. # OctoTray Linux Qt System Tray OctoPrint client
  3. #
  4. # depends on:
  5. # - python-pyqt5
  6. #
  7. # see also:
  8. # https://doc.qt.io/qt-5/qtwidgets-widgets-imageviewer-example.html
  9. # https://stackoverflow.com/a/22618496
  10. import json
  11. import sys
  12. import os
  13. import time
  14. import string
  15. import urllib.parse
  16. import urllib.request
  17. import signal
  18. import operator
  19. import socket
  20. from os import path
  21. from PyQt5 import QtWidgets, QtGui, QtCore, QtNetwork
  22. from PyQt5.QtWidgets import QSystemTrayIcon, QAction, QMenu, QMessageBox, QWidget, QLabel, QVBoxLayout, QHBoxLayout, QDesktopWidget, QSizePolicy, QSlider, QLayout, QTableWidget, QTableWidgetItem, QPushButton, QApplication, QLineEdit, QGridLayout
  23. from PyQt5.QtGui import QIcon, QPixmap, QImageReader, QDesktopServices, QFontDatabase, QCursor, QIntValidator
  24. from PyQt5.QtCore import QCoreApplication, QSettings, QUrl, QTimer, QSize, Qt, QSettings
  25. class SettingsWindow(QWidget):
  26. columns = [ "Hostname", "API Key", "Tool Preheat", "Bed Preheat" ]
  27. presets = [ "octopi.local", "000000000_API_KEY_HERE_000000000", "0", "0" ]
  28. def __init__(self, parent, *args, **kwargs):
  29. super(SettingsWindow, self).__init__(*args, **kwargs)
  30. self.parent = parent
  31. self.setWindowTitle(parent.name + " Settings")
  32. self.setWindowIcon(parent.icon)
  33. box = QVBoxLayout()
  34. self.setLayout(box)
  35. staticSettings = QGridLayout()
  36. box.addLayout(staticSettings, 0)
  37. self.jogSpeedText = QLabel("Jog Speed")
  38. staticSettings.addWidget(self.jogSpeedText, 0, 0)
  39. self.jogSpeed = QLineEdit(str(self.parent.jogMoveSpeed))
  40. self.jogSpeed.setValidator(QIntValidator(1, 6000))
  41. staticSettings.addWidget(self.jogSpeed, 0, 1)
  42. self.jogSpeedUnitText = QLabel("mm/min")
  43. staticSettings.addWidget(self.jogSpeedUnitText, 0, 2)
  44. self.jogLengthText = QLabel("Jog Length")
  45. staticSettings.addWidget(self.jogLengthText, 1, 0)
  46. self.jogLength = QLineEdit(str(self.parent.jogMoveLength))
  47. self.jogLength.setValidator(QIntValidator(1, 100))
  48. staticSettings.addWidget(self.jogLength, 1, 1)
  49. self.jogLengthUnitText = QLabel("mm")
  50. staticSettings.addWidget(self.jogLengthUnitText, 1, 2)
  51. helpText = "Usage:\n"
  52. helpText += "1st Column: Printer Hostname or IP address\n"
  53. helpText += "2nd Column: OctoPrint API Key (32 char hexadecimal)\n"
  54. helpText += "3rd Column: Tool Preheat Temperature (0 to disable)\n"
  55. helpText += "4th Column: Bed Preheat Temperature (0 to disable)"
  56. self.helpText = QLabel(helpText)
  57. box.addWidget(self.helpText, 0)
  58. box.setAlignment(self.helpText, Qt.AlignHCenter)
  59. buttons = QHBoxLayout()
  60. box.addLayout(buttons, 0)
  61. self.add = QPushButton("&Add Printer")
  62. self.add.clicked.connect(self.addPrinter)
  63. buttons.addWidget(self.add)
  64. self.remove = QPushButton("&Remove Printer")
  65. self.remove.clicked.connect(self.removePrinter)
  66. buttons.addWidget(self.remove)
  67. printers = self.parent.readSettings()
  68. self.rows = len(printers)
  69. self.table = QTableWidget(self.rows, len(self.columns))
  70. box.addWidget(self.table, 1)
  71. for i in range(0, self.rows):
  72. p = printers[i]
  73. for j in range(0, len(self.columns)):
  74. text = p[j]
  75. if (j >= 2) and (j <= 3) and (text == None):
  76. text = "0"
  77. item = QTableWidgetItem(text)
  78. self.table.setItem(i, j, item)
  79. if j == 1:
  80. font = item.font()
  81. font.setFamily(QFontDatabase.systemFont(QFontDatabase.FixedFont).family())
  82. item.setFont(font)
  83. buttons2 = QHBoxLayout()
  84. box.addLayout(buttons2, 0)
  85. self.up = QPushButton("Move &Up")
  86. self.up.clicked.connect(self.moveUp)
  87. buttons2.addWidget(self.up)
  88. self.down = QPushButton("Move &Down")
  89. self.down.clicked.connect(self.moveDown)
  90. buttons2.addWidget(self.down)
  91. self.openWeb = QPushButton("&Open Web UI of selected")
  92. self.openWeb.clicked.connect(self.openWebUI)
  93. box.addWidget(self.openWeb, 0)
  94. self.table.setHorizontalHeaderLabels(self.columns)
  95. self.table.setSizeAdjustPolicy(QtWidgets.QAbstractScrollArea.AdjustToContents)
  96. self.table.setSelectionBehavior(QtWidgets.QAbstractItemView.SelectRows);
  97. self.table.resizeColumnsToContents()
  98. if self.rows <= 0:
  99. self.addPrinter()
  100. def tableToList(self):
  101. printers = []
  102. for i in range(0, self.rows):
  103. p = []
  104. for j in range(0, len(self.columns)):
  105. text = self.table.item(i, j).text()
  106. if (j >= 2) and (j <= 3) and (text == "0"):
  107. text = None
  108. p.append(text)
  109. printers.append(p)
  110. return printers
  111. def settingsValid(self, printers):
  112. for p in printers:
  113. # p[0] needs to be valid hostname or IP
  114. # TODO
  115. # p[1] needs to be valid API key (hexadecimal, 32 chars)
  116. if (len(p[1]) != 32) or not all(c in string.hexdigits for c in p[1]):
  117. return (False, "API Key not 32-digit hexadecimal")
  118. # p[2] and p[3] need to be integer temperatures (0...999)
  119. for s in [ p[2], p[3] ]:
  120. if s == None:
  121. s = "0"
  122. if (len(s) < 1) or (len(s) > 3) or not all(c in string.digits for c in s):
  123. return (False, "Temperature not a number from 0...999")
  124. js = int(self.jogSpeed.text())
  125. if (js < 1) or (js > 6000):
  126. return (False, "Jog Speed not a number from 1...6000")
  127. jl = int(self.jogLength.text())
  128. if (jl < 1) or (jl > 100):
  129. return (False, "Jog Length not a number from 1...100")
  130. return (True, "")
  131. def closeEvent(self, event):
  132. oldPrinters = [item[0:len(self.columns)] for item in self.parent.printers]
  133. newPrinters = self.tableToList()
  134. valid, errorText = self.settingsValid(newPrinters)
  135. if valid == False:
  136. r = self.parent.showDialog(self.parent.name + " Settings Invalid", errorText + "!", "Do you want to edit it again?", True, True, False)
  137. if r == True:
  138. event.ignore()
  139. return
  140. else:
  141. self.parent.removeSettingsWindow()
  142. return
  143. js = int(self.jogSpeed.text())
  144. jl = int(self.jogLength.text())
  145. if (oldPrinters != newPrinters) or (js != self.parent.jogMoveSpeed) or (jl != self.parent.jogMoveLength):
  146. r = self.parent.showDialog(self.parent.name + " Settings Changed", "Do you want to save the new configuration?", "This will restart the application!", True, False, False)
  147. if r == True:
  148. self.parent.jogMoveSpeed = js
  149. self.parent.jogMoveLength = jl
  150. self.parent.writeSettings(newPrinters)
  151. self.parent.restartApp()
  152. self.parent.removeSettingsWindow()
  153. def addPrinter(self):
  154. self.rows += 1
  155. self.table.setRowCount(self.rows)
  156. for i in range(0, len(self.columns)):
  157. item = QTableWidgetItem(self.presets[i])
  158. self.table.setItem(self.rows - 1, i, item)
  159. if i == 1:
  160. font = item.font()
  161. font.setFamily(QFontDatabase.systemFont(QFontDatabase.FixedFont).family())
  162. item.setFont(font)
  163. self.table.resizeColumnsToContents()
  164. self.table.setCurrentItem(self.table.item(self.rows - 1, 0))
  165. def removePrinter(self):
  166. r = self.table.currentRow()
  167. if (r >= 0) and (r < self.rows):
  168. self.rows -= 1
  169. self.table.removeRow(r)
  170. self.table.setCurrentItem(self.table.item(min(r, self.rows - 1), 0))
  171. def moveUp(self):
  172. i = self.table.currentRow()
  173. if i <= 0:
  174. return
  175. host = self.table.item(i, 0).text()
  176. key = self.table.item(i, 1).text()
  177. self.table.item(i, 0).setText(self.table.item(i - 1, 0).text())
  178. self.table.item(i, 1).setText(self.table.item(i - 1, 1).text())
  179. self.table.item(i - 1, 0).setText(host)
  180. self.table.item(i - 1, 1).setText(key)
  181. self.table.setCurrentItem(self.table.item(i - 1, 0))
  182. def moveDown(self):
  183. i = self.table.currentRow()
  184. if i >= (self.rows - 1):
  185. return
  186. host = self.table.item(i, 0).text()
  187. key = self.table.item(i, 1).text()
  188. self.table.item(i, 0).setText(self.table.item(i + 1, 0).text())
  189. self.table.item(i, 1).setText(self.table.item(i + 1, 1).text())
  190. self.table.item(i + 1, 0).setText(host)
  191. self.table.item(i + 1, 1).setText(key)
  192. self.table.setCurrentItem(self.table.item(i + 1, 0))
  193. def openWebUI(self):
  194. host = self.table.item(self.table.currentRow(), 0).text()
  195. self.parent.openBrowser(host)
  196. class AspectRatioPixmapLabel(QLabel):
  197. def __init__(self, *args, **kwargs):
  198. super(AspectRatioPixmapLabel, self).__init__(*args, **kwargs)
  199. self.setMinimumSize(1, 1)
  200. self.setScaledContents(False)
  201. self.pix = QPixmap(0, 0)
  202. def setPixmap(self, p):
  203. self.pix = p
  204. super(AspectRatioPixmapLabel, self).setPixmap(self.scaledPixmap())
  205. def heightForWidth(self, width):
  206. if self.pix.isNull():
  207. return self.height()
  208. else:
  209. return (self.pix.height() * width) / self.pix.width()
  210. def sizeHint(self):
  211. w = self.width()
  212. return QSize(int(w), int(self.heightForWidth(w)))
  213. def scaledPixmap(self):
  214. return self.pix.scaled(self.size(), Qt.KeepAspectRatio, Qt.SmoothTransformation)
  215. def resizeEvent(self, e):
  216. if not self.pix.isNull():
  217. super(AspectRatioPixmapLabel, self).setPixmap(self.scaledPixmap())
  218. class CamWindow(QWidget):
  219. reloadDelayDefault = 1000 # in ms
  220. statusDelayFactor = 2
  221. reloadOn = True
  222. sliderFactor = 100
  223. def __init__(self, parent, printer, *args, **kwargs):
  224. super(CamWindow, self).__init__(*args, **kwargs)
  225. self.app = parent.app
  226. self.manager = parent.manager
  227. self.manager.finished.connect(self.handleResponse)
  228. self.parent = parent
  229. self.printer = printer
  230. self.host = self.printer[0]
  231. self.url = "http://" + self.host + ":8080/?action=snapshot"
  232. self.setWindowTitle(parent.name + " Webcam Stream")
  233. self.setWindowIcon(parent.icon)
  234. box = QVBoxLayout()
  235. self.setLayout(box)
  236. label = QLabel(self.url)
  237. box.addWidget(label, 0)
  238. box.setAlignment(label, Qt.AlignHCenter)
  239. slide = QHBoxLayout()
  240. box.addLayout(slide, 0)
  241. self.slideStaticLabel = QLabel("Refresh")
  242. slide.addWidget(self.slideStaticLabel, 0)
  243. self.slider = QSlider(Qt.Horizontal)
  244. self.slider.setMinimum(int(100 / self.sliderFactor))
  245. self.slider.setMaximum(int(2000 / self.sliderFactor))
  246. self.slider.setTickInterval(int(100 / self.sliderFactor))
  247. self.slider.setPageStep(int(100 / self.sliderFactor))
  248. self.slider.setSingleStep(int(100 / self.sliderFactor))
  249. self.slider.setTickPosition(QSlider.TicksBelow)
  250. self.slider.setValue(int(self.reloadDelayDefault / self.sliderFactor))
  251. self.slider.valueChanged.connect(self.sliderChanged)
  252. slide.addWidget(self.slider, 1)
  253. self.slideLabel = QLabel(str(self.reloadDelayDefault) + "ms")
  254. slide.addWidget(self.slideLabel, 0)
  255. self.img = AspectRatioPixmapLabel()
  256. self.img.setPixmap(QPixmap(640, 480))
  257. box.addWidget(self.img, 1)
  258. self.statusLabel = QLabel("Status: unavailable")
  259. box.addWidget(self.statusLabel, 0)
  260. box.setAlignment(self.statusLabel, Qt.AlignHCenter)
  261. self.method = self.parent.getMethod(self.printer[0], self.printer[1])
  262. if self.method != "unknown":
  263. controls_power = QHBoxLayout()
  264. box.addLayout(controls_power, 0)
  265. self.turnOnButton = QPushButton("Turn O&n")
  266. self.turnOnButton.clicked.connect(self.turnOn)
  267. controls_power.addWidget(self.turnOnButton)
  268. self.turnOffButton = QPushButton("Turn O&ff")
  269. self.turnOffButton.clicked.connect(self.turnOff)
  270. controls_power.addWidget(self.turnOffButton)
  271. controls_temp = QHBoxLayout()
  272. box.addLayout(controls_temp, 0)
  273. self.cooldownButton = QPushButton("&Cooldown")
  274. self.cooldownButton.clicked.connect(self.cooldown)
  275. controls_temp.addWidget(self.cooldownButton)
  276. self.preheatToolButton = QPushButton("Preheat &Tool")
  277. self.preheatToolButton.clicked.connect(self.preheatTool)
  278. controls_temp.addWidget(self.preheatToolButton)
  279. self.preheatBedButton = QPushButton("Preheat &Bed")
  280. self.preheatBedButton.clicked.connect(self.preheatBed)
  281. controls_temp.addWidget(self.preheatBedButton)
  282. controls_home = QHBoxLayout()
  283. box.addLayout(controls_home, 0)
  284. self.homeAllButton = QPushButton("Home &All")
  285. self.homeAllButton.clicked.connect(self.homeAll)
  286. controls_home.addWidget(self.homeAllButton, 1)
  287. self.homeXButton = QPushButton("Home &X")
  288. self.homeXButton.clicked.connect(self.homeX)
  289. controls_home.addWidget(self.homeXButton, 0)
  290. self.homeYButton = QPushButton("Home &Y")
  291. self.homeYButton.clicked.connect(self.homeY)
  292. controls_home.addWidget(self.homeYButton, 0)
  293. self.homeZButton = QPushButton("Home &Z")
  294. self.homeZButton.clicked.connect(self.homeZ)
  295. controls_home.addWidget(self.homeZButton, 0)
  296. controls_move = QHBoxLayout()
  297. box.addLayout(controls_move, 0)
  298. self.XPButton = QPushButton("X+")
  299. self.XPButton.clicked.connect(self.moveXP)
  300. controls_move.addWidget(self.XPButton)
  301. self.XMButton = QPushButton("X-")
  302. self.XMButton.clicked.connect(self.moveXM)
  303. controls_move.addWidget(self.XMButton)
  304. self.YPButton = QPushButton("Y+")
  305. self.YPButton.clicked.connect(self.moveYP)
  306. controls_move.addWidget(self.YPButton)
  307. self.YMButton = QPushButton("Y-")
  308. self.YMButton.clicked.connect(self.moveYM)
  309. controls_move.addWidget(self.YMButton)
  310. self.ZPButton = QPushButton("Z+")
  311. self.ZPButton.clicked.connect(self.moveZP)
  312. controls_move.addWidget(self.ZPButton)
  313. self.ZMButton = QPushButton("Z-")
  314. self.ZMButton.clicked.connect(self.moveZM)
  315. controls_move.addWidget(self.ZMButton)
  316. self.loadImage()
  317. self.loadStatus()
  318. def moveXP(self):
  319. self.parent.printerMoveAction(self.printer, "x", int(self.parent.jogMoveLength), True)
  320. def moveXM(self):
  321. self.parent.printerMoveAction(self.printer, "x", -1 * int(self.parent.jogMoveLength), True)
  322. def moveYP(self):
  323. self.parent.printerMoveAction(self.printer, "y", int(self.parent.jogMoveLength), True)
  324. def moveYM(self):
  325. self.parent.printerMoveAction(self.printer, "y", -1 * int(self.parent.jogMoveLength), True)
  326. def moveZP(self):
  327. self.parent.printerMoveAction(self.printer, "z", int(self.parent.jogMoveLength), True)
  328. def moveZM(self):
  329. self.parent.printerMoveAction(self.printer, "z", -1 * int(self.parent.jogMoveLength), True)
  330. def homeX(self):
  331. self.parent.printerHomingAction(self.printer, "x")
  332. def homeY(self):
  333. self.parent.printerHomingAction(self.printer, "y")
  334. def homeZ(self):
  335. self.parent.printerHomingAction(self.printer, "z")
  336. def homeAll(self):
  337. self.parent.printerHomingAction(self.printer, "xyz")
  338. def turnOn(self):
  339. if self.method == "psucontrol":
  340. self.parent.printerOnAction(self.printer)
  341. elif self.method == "system":
  342. cmds = self.parent.getSystemCommands(self.printer[0], self.printer[1])
  343. for cmd in cmds:
  344. if "on" in cmd:
  345. self.parent.setSystemCommand(self.printer[0], self.printer[1], cmd)
  346. break
  347. def turnOff(self):
  348. if self.method == "psucontrol":
  349. self.parent.printerOffAction(self.printer)
  350. elif self.method == "system":
  351. cmds = self.parent.getSystemCommands(self.printer[0], self.printer[1])
  352. for cmd in cmds:
  353. if "off" in cmd:
  354. self.parent.setSystemCommand(self.printer[0], self.printer[1], cmd)
  355. break
  356. def cooldown(self):
  357. self.parent.printerCooldown(self.printer)
  358. def preheatTool(self):
  359. self.parent.printerHeatTool(self.printer)
  360. def preheatBed(self):
  361. self.parent.printerHeatBed(self.printer)
  362. def getHost(self):
  363. return self.host
  364. def sliderChanged(self):
  365. self.slideLabel.setText(str(self.slider.value() * self.sliderFactor) + "ms")
  366. def closeEvent(self, event):
  367. self.reloadOn = False
  368. self.url = ""
  369. self.parent.removeWebcamWindow(self)
  370. def scheduleLoadImage(self):
  371. if self.reloadOn:
  372. QTimer.singleShot(self.slider.value() * self.sliderFactor, self.loadImage)
  373. def scheduleLoadStatus(self):
  374. if self.reloadOn:
  375. QTimer.singleShot(self.slider.value() * self.sliderFactor * self.statusDelayFactor, self.loadStatus)
  376. def loadImage(self):
  377. url = QUrl(self.url)
  378. request = QtNetwork.QNetworkRequest(url)
  379. self.manager.get(request)
  380. def loadStatus(self):
  381. s = "Status: "
  382. t = self.parent.getTemperatureString(self.host, self.printer[1])
  383. if len(t) > 0:
  384. s += t
  385. else:
  386. s += "Unknown"
  387. progress = self.parent.getProgress(self.host, self.printer[1])
  388. if ("completion" in progress) and ("printTime" in progress) and ("printTimeLeft" in progress) and (progress["completion"] != None) and (progress["printTime"] != None) and (progress["printTimeLeft"] != None):
  389. s += " - %.1f%%" % progress["completion"]
  390. s += " - runtime "
  391. s += time.strftime("%H:%M:%S", time.gmtime(progress["printTime"]))
  392. s += " - "
  393. s += time.strftime("%H:%M:%S", time.gmtime(progress["printTimeLeft"])) + " left"
  394. self.statusLabel.setText(s)
  395. self.scheduleLoadStatus()
  396. def handleResponse(self, reply):
  397. if reply.url().url() == self.url:
  398. if reply.error() == QtNetwork.QNetworkReply.NoError:
  399. reader = QImageReader(reply)
  400. reader.setAutoTransform(True)
  401. image = reader.read()
  402. if image != None:
  403. if image.colorSpace().isValid():
  404. image.convertToColorSpace(QColorSpace.SRgb)
  405. self.img.setPixmap(QPixmap.fromImage(image))
  406. self.scheduleLoadImage()
  407. else:
  408. print("Error decoding image: " + reader.errorString())
  409. else:
  410. print("Error loading image: " + reply.errorString())
  411. class MainWindow(QWidget):
  412. def __init__(self, parent, *args, **kwargs):
  413. super(MainWindow, self).__init__(*args, **kwargs)
  414. self.parent = parent
  415. self.mainLayout = QVBoxLayout()
  416. self.setLayout(self.mainLayout)
  417. self.mainLayout.addWidget(self.parent.menu)
  418. self.parent.menu.aboutToHide.connect(self.aboutToHide)
  419. def aboutToHide(self):
  420. self.parent.menu.show()
  421. def closeEvent(self, event):
  422. self.parent.exit()
  423. event.accept()
  424. class OctoTray():
  425. name = "OctoTray"
  426. vendor = "xythobuz"
  427. version = "0.4"
  428. iconName = "octotray_icon.png"
  429. iconPaths = [
  430. path.abspath(path.dirname(__file__)),
  431. "data",
  432. "/usr/share/pixmaps",
  433. ".",
  434. "..",
  435. "../data"
  436. ]
  437. networkTimeout = 2.0 # in s
  438. # list of lists, inner lists contain printer data:
  439. # first elements as in SettingsWindow.columns
  440. # 0=host 1=key 2=tool-preheat 3=bed-preheat
  441. # rest used for system-commands, menu, actions
  442. printers = []
  443. statesWithWarning = [
  444. "Printing", "Pausing", "Paused"
  445. ]
  446. camWindows = []
  447. settingsWindow = None
  448. # default, can be overridden in config
  449. jogMoveSpeed = 10 * 60 # in mm/min
  450. jogMoveLength = 10 # in mm
  451. def __init__(self, app, inSysTray):
  452. QCoreApplication.setApplicationName(self.name)
  453. self.app = app
  454. self.inSysTray = inSysTray
  455. self.manager = QtNetwork.QNetworkAccessManager()
  456. self.menu = QMenu()
  457. self.printers = self.readSettings()
  458. unknownCount = 0
  459. for p in self.printers:
  460. method = self.getMethod(p[0], p[1])
  461. print("Printer " + p[0] + " has method " + method)
  462. if method == "unknown":
  463. unknownCount += 1
  464. action = QAction(p[0])
  465. action.setEnabled(False)
  466. p.append(action)
  467. self.menu.addAction(action)
  468. continue
  469. commands = self.getSystemCommands(p[0], p[1])
  470. p.append(commands)
  471. menu = QMenu(self.getName(p[0], p[1]))
  472. p.append(menu)
  473. self.menu.addMenu(menu)
  474. if method == "psucontrol":
  475. action = QAction("Turn On PSU")
  476. action.triggered.connect(lambda chk, x=p: self.printerOnAction(x))
  477. p.append(action)
  478. menu.addAction(action)
  479. action = QAction("Turn Off PSU")
  480. action.triggered.connect(lambda chk, x=p: self.printerOffAction(x))
  481. p.append(action)
  482. menu.addAction(action)
  483. for i in range(0, len(commands)):
  484. action = QAction(commands[i].title())
  485. action.triggered.connect(lambda chk, x=p, y=i: self.printerSystemCommandAction(x, y))
  486. p.append(action)
  487. menu.addAction(action)
  488. if (p[2] != None) or (p[3] != None):
  489. menu.addSeparator()
  490. if p[2] != None:
  491. action = QAction("Preheat Tool")
  492. action.triggered.connect(lambda chk, x=p: self.printerHeatTool(x))
  493. p.append(action)
  494. menu.addAction(action)
  495. if p[3] != None:
  496. action = QAction("Preheat Bed")
  497. action.triggered.connect(lambda chk, x=p: self.printerHeatBed(x))
  498. p.append(action)
  499. menu.addAction(action)
  500. if (p[2] != None) or (p[3] != None):
  501. action = QAction("Cooldown")
  502. action.triggered.connect(lambda chk, x=p: self.printerCooldown(x))
  503. p.append(action)
  504. menu.addAction(action)
  505. menu.addSeparator()
  506. fileMenu = QMenu("Recent Files")
  507. p.append(fileMenu)
  508. menu.addMenu(fileMenu)
  509. files = self.getRecentFiles(p[0], p[1], 10)
  510. for f in files:
  511. fileName, filePath = f
  512. action = QAction(fileName)
  513. action.triggered.connect(lambda chk, x=p, y=filePath: self.printerFilePrint(x, y))
  514. p.append(action)
  515. fileMenu.addAction(action)
  516. action = QAction("Get Status")
  517. action.triggered.connect(lambda chk, x=p: self.printerStatusAction(x))
  518. p.append(action)
  519. menu.addAction(action)
  520. action = QAction("Show Webcam")
  521. action.triggered.connect(lambda chk, x=p: self.printerWebcamAction(x))
  522. p.append(action)
  523. menu.addAction(action)
  524. action = QAction("Open Web UI")
  525. action.triggered.connect(lambda chk, x=p: self.printerWebAction(x))
  526. p.append(action)
  527. menu.addAction(action)
  528. self.menu.addSeparator()
  529. self.settingsAction = QAction("&Settings")
  530. self.settingsAction.triggered.connect(self.showSettingsAction)
  531. self.menu.addAction(self.settingsAction)
  532. self.refreshAction = QAction("&Refresh")
  533. self.refreshAction.triggered.connect(self.restartApp)
  534. self.menu.addAction(self.refreshAction)
  535. self.quitAction = QAction("&Quit")
  536. self.quitAction.triggered.connect(self.exit)
  537. self.menu.addAction(self.quitAction)
  538. self.iconPathName = None
  539. for p in self.iconPaths:
  540. if os.path.isfile(path.join(p, self.iconName)):
  541. self.iconPathName = path.join(p, self.iconName)
  542. break
  543. if self.iconPathName == None:
  544. self.showDialog("OctoTray Error", "Icon file has not been found!", "", False, False, True)
  545. sys.exit(0)
  546. self.icon = QIcon()
  547. self.pic = QPixmap(32, 32)
  548. self.pic.load(self.iconPathName)
  549. self.icon = QIcon(self.pic)
  550. if self.inSysTray:
  551. self.trayIcon = QSystemTrayIcon(self.icon)
  552. self.trayIcon.setToolTip(self.name + " " + self.version)
  553. self.trayIcon.setContextMenu(self.menu)
  554. self.trayIcon.activated.connect(self.showHide)
  555. self.trayIcon.setVisible(True)
  556. else:
  557. self.mainWindow = MainWindow(self)
  558. self.mainWindow.show()
  559. self.mainWindow.activateWindow()
  560. screenGeometry = QDesktopWidget().screenGeometry()
  561. x = (screenGeometry.width() - self.mainWindow.width()) / 2
  562. y = (screenGeometry.height() - self.mainWindow.height()) / 2
  563. x += screenGeometry.x()
  564. y += screenGeometry.y()
  565. self.mainWindow.setGeometry(int(x), int(y), int(self.mainWindow.width()), int(self.mainWindow.height()))
  566. def showHide(self, activationReason):
  567. if activationReason == QSystemTrayIcon.Trigger:
  568. self.menu.popup(QCursor.pos())
  569. elif activationReason == QSystemTrayIcon.MiddleClick:
  570. if len(self.printers) > 0:
  571. self.printerWebcamAction(self.printers[0])
  572. def readSettings(self):
  573. settings = QSettings(self.vendor, self.name)
  574. js = settings.value("jog_speed")
  575. if js != None:
  576. self.jogMoveSpeed = int(js)
  577. jl = settings.value("jog_length")
  578. if jl != None:
  579. self.jogMoveLength = int(jl)
  580. printers = []
  581. l = settings.beginReadArray("printers")
  582. for i in range(0, l):
  583. settings.setArrayIndex(i)
  584. p = []
  585. p.append(settings.value("host"))
  586. p.append(settings.value("key"))
  587. p.append(settings.value("tool_preheat"))
  588. p.append(settings.value("bed_preheat"))
  589. printers.append(p)
  590. settings.endArray()
  591. return printers
  592. def writeSettings(self, printers):
  593. settings = QSettings(self.vendor, self.name)
  594. settings.setValue("jog_speed", self.jogMoveSpeed)
  595. settings.setValue("jog_length", self.jogMoveLength)
  596. settings.remove("printers")
  597. settings.beginWriteArray("printers")
  598. for i in range(0, len(printers)):
  599. p = printers[i]
  600. settings.setArrayIndex(i)
  601. settings.setValue("host", p[0])
  602. settings.setValue("key", p[1])
  603. settings.setValue("tool_preheat", p[2])
  604. settings.setValue("bed_preheat", p[3])
  605. settings.endArray()
  606. del settings
  607. def openBrowser(self, url):
  608. QDesktopServices.openUrl(QUrl("http://" + url))
  609. def showDialog(self, title, text1, text2 = "", question = False, warning = False, error = False):
  610. msg = QMessageBox()
  611. if error:
  612. msg.setIcon(QMessageBox.Critical)
  613. elif warning:
  614. msg.setIcon(QMessageBox.Warning)
  615. elif question:
  616. msg.setIcon(QMessageBox.Question)
  617. else:
  618. msg.setIcon(QMessageBox.Information)
  619. msg.setWindowTitle(title)
  620. msg.setText(text1)
  621. if text2 is not None:
  622. msg.setInformativeText(text2)
  623. if question:
  624. msg.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
  625. else:
  626. msg.setStandardButtons(QMessageBox.Ok)
  627. retval = msg.exec_()
  628. if retval == QMessageBox.Yes:
  629. return True
  630. else:
  631. return False
  632. def sendRequest(self, host, headers, path, content = None):
  633. url = "http://" + host + "/api/" + path
  634. if content == None:
  635. request = urllib.request.Request(url, None, headers)
  636. else:
  637. data = content.encode('ascii')
  638. request = urllib.request.Request(url, data, headers)
  639. try:
  640. with urllib.request.urlopen(request, None, self.networkTimeout) as response:
  641. text = response.read()
  642. return text
  643. except (urllib.error.URLError, urllib.error.HTTPError) as error:
  644. print("Error requesting URL \"" + url + "\": \"" + str(error) + "\"")
  645. return "error"
  646. except socket.timeout:
  647. print("Timeout waiting for response to \"" + url + "\"")
  648. return "timeout"
  649. def sendPostRequest(self, host, key, path, content):
  650. headers = {
  651. "Content-Type": "application/json",
  652. "X-Api-Key": key
  653. }
  654. return self.sendRequest(host, headers, path, content)
  655. def sendGetRequest(self, host, key, path):
  656. headers = {
  657. "X-Api-Key": key
  658. }
  659. return self.sendRequest(host, headers, path)
  660. def getTemperatureIsSafe(self, host, key):
  661. r = self.sendGetRequest(host, key, "printer")
  662. try:
  663. rd = json.loads(r)
  664. if "temperature" in rd:
  665. if ("tool0" in rd["temperature"]) and ("actual" in rd["temperature"]["tool0"]):
  666. if rd["temperature"]["tool0"]["actual"] > 50.0:
  667. return False
  668. if ("tool1" in rd["temperature"]) and ("actual" in rd["temperature"]["tool1"]):
  669. if rd["temperature"]["tool1"]["actual"] > 50.0:
  670. return False
  671. except json.JSONDecodeError:
  672. pass
  673. return True
  674. def getTemperatureString(self, host, key):
  675. r = self.sendGetRequest(host, key, "printer")
  676. s = ""
  677. try:
  678. rd = json.loads(r)
  679. if ("state" in rd) and ("text" in rd["state"]):
  680. s += rd["state"]["text"]
  681. if "temperature" in rd:
  682. s += " - "
  683. if "temperature" in rd:
  684. if "bed" in rd["temperature"]:
  685. if "actual" in rd["temperature"]["bed"]:
  686. s += "B"
  687. s += "%.1f" % rd["temperature"]["bed"]["actual"]
  688. if "target" in rd["temperature"]["bed"]:
  689. s += "/"
  690. s += "%.1f" % rd["temperature"]["bed"]["target"]
  691. s += " "
  692. if "tool0" in rd["temperature"]:
  693. if "actual" in rd["temperature"]["tool0"]:
  694. s += "T"
  695. s += "%.1f" % rd["temperature"]["tool0"]["actual"]
  696. if "target" in rd["temperature"]["tool0"]:
  697. s += "/"
  698. s += "%.1f" % rd["temperature"]["tool0"]["target"]
  699. s += " "
  700. if "tool1" in rd["temperature"]:
  701. if "actual" in rd["temperature"]["tool1"]:
  702. s += "T"
  703. s += "%.1f" % rd["temperature"]["tool1"]["actual"]
  704. if "target" in rd["temperature"]["tool1"]:
  705. s += "/"
  706. s += "%.1f" % rd["temperature"]["tool1"]["target"]
  707. s += " "
  708. except json.JSONDecodeError:
  709. pass
  710. return s.strip()
  711. def getState(self, host, key):
  712. r = self.sendGetRequest(host, key, "job")
  713. try:
  714. rd = json.loads(r)
  715. if "state" in rd:
  716. return rd["state"]
  717. except json.JSONDecodeError:
  718. pass
  719. return "Unknown"
  720. def getProgress(self, host, key):
  721. r = self.sendGetRequest(host, key, "job")
  722. try:
  723. rd = json.loads(r)
  724. if "progress" in rd:
  725. return rd["progress"]
  726. except json.JSONDecodeError:
  727. pass
  728. return "Unknown"
  729. def getName(self, host, key):
  730. r = self.sendGetRequest(host, key, "printerprofiles")
  731. try:
  732. rd = json.loads(r)
  733. if "profiles" in rd:
  734. p = next(iter(rd["profiles"]))
  735. if "name" in rd["profiles"][p]:
  736. return rd["profiles"][p]["name"]
  737. except json.JSONDecodeError:
  738. pass
  739. return host
  740. def getRecentFiles(self, host, key, count):
  741. r = self.sendGetRequest(host, key, "files?recursive=true")
  742. files = []
  743. try:
  744. rd = json.loads(r)
  745. if "files" in rd:
  746. t = [f for f in rd["files"] if "date" in f]
  747. fs = sorted(t, key=operator.itemgetter("date"), reverse=True)
  748. for f in fs[:count]:
  749. files.append((f["name"], f["origin"] + "/" + f["path"]))
  750. except json.JSONDecodeError:
  751. pass
  752. return files
  753. def getMethod(self, host, key):
  754. r = self.sendGetRequest(host, key, "plugin/psucontrol")
  755. if r == "timeout":
  756. return "unknown"
  757. try:
  758. rd = json.loads(r)
  759. if "isPSUOn" in rd:
  760. return "psucontrol"
  761. except json.JSONDecodeError:
  762. pass
  763. r = self.sendGetRequest(host, key, "system/commands/custom")
  764. if r == "timeout":
  765. return "unknown"
  766. try:
  767. rd = json.loads(r)
  768. for c in rd:
  769. if "action" in c:
  770. # we have some custom commands and no psucontrol
  771. # so lets try to use that instead of skipping
  772. # the printer completely with 'unknown'
  773. return "system"
  774. except json.JSONDecodeError:
  775. pass
  776. return "unknown"
  777. def getSystemCommands(self, host, key):
  778. l = []
  779. r = self.sendGetRequest(host, key, "system/commands/custom")
  780. try:
  781. rd = json.loads(r)
  782. if len(rd) > 0:
  783. print("system commands available for " + host + ":")
  784. for c in rd:
  785. if "action" in c:
  786. print(" - " + c["action"])
  787. l.append(c["action"])
  788. except json.JSONDecodeError:
  789. pass
  790. return l
  791. def setPSUControl(self, host, key, state):
  792. cmd = "turnPSUOff"
  793. if state:
  794. cmd = "turnPSUOn"
  795. return self.sendPostRequest(host, key, "plugin/psucontrol", '{ "command":"' + cmd + '" }')
  796. def setSystemCommand(self, host, key, cmd):
  797. cmd = urllib.parse.quote(cmd)
  798. return self.sendPostRequest(host, key, "system/commands/custom/" + cmd, '')
  799. def exit(self):
  800. QCoreApplication.quit()
  801. def printerSystemCommandAction(self, item, index):
  802. if "off" in item[2][index].lower():
  803. state = self.getState(item[0], item[1])
  804. if state in self.statesWithWarning:
  805. if self.showDialog("OctoTray Warning", "The printer seems to be running currently!", "Do you really want to run '" + item[2][index] + "'?", True, True) == False:
  806. return
  807. safe = self.getTemperatureIsSafe(item[0], item[1])
  808. if safe == False:
  809. if self.showDialog("OctoTray Warning", "The printer seems to still be hot!", "Do you really want to turn it off?", True, True) == False:
  810. return
  811. self.setSystemCommand(item[0], item[1], item[2][index])
  812. def printerOnAction(self, item):
  813. self.setPSUControl(item[0], item[1], True)
  814. def printerOffAction(self, item):
  815. state = self.getState(item[0], item[1])
  816. if state in self.statesWithWarning:
  817. if self.showDialog("OctoTray Warning", "The printer seems to be running currently!", "Do you really want to turn it off?", True, True) == False:
  818. return
  819. safe = self.getTemperatureIsSafe(item[0], item[1])
  820. if safe == False:
  821. if self.showDialog("OctoTray Warning", "The printer seems to still be hot!", "Do you really want to turn it off?", True, True) == False:
  822. return
  823. self.setPSUControl(item[0], item[1], False)
  824. def printerHomingAction(self, item, axes = "xyz"):
  825. state = self.getState(item[0], item[1])
  826. if state in self.statesWithWarning:
  827. if self.showDialog("OctoTray Warning", "The printer seems to be running currently!", "Do you really want to home it?", True, True) == False:
  828. return
  829. axes_string = ''
  830. for i in range(0, len(axes)):
  831. axes_string += '"' + str(axes[i]) + '"'
  832. if i < (len(axes) - 1):
  833. axes_string += ', '
  834. self.sendPostRequest(item[0], item[1], "printer/printhead", '{ "command": "home", "axes": [' + axes_string + '] }')
  835. def printerMoveAction(self, printer, axis, dist, relative = True):
  836. state = self.getState(printer[0], printer[1])
  837. if state in self.statesWithWarning:
  838. if self.showDialog("OctoTray Warning", "The printer seems to be running currently!", "Do you really want to move it?", True, True) == False:
  839. return
  840. absolute = ''
  841. if relative == False:
  842. absolute = ', "absolute": true'
  843. self.sendPostRequest(printer[0], printer[1], "printer/printhead", '{ "command": "jog", "' + str(axis) + '": ' + str(dist) + ', "speed": ' + str(self.jogMoveSpeed) + absolute + ' }')
  844. def printerWebAction(self, item):
  845. self.openBrowser(item[0])
  846. def printerStatusAction(self, item):
  847. progress = self.getProgress(item[0], item[1])
  848. s = item[0] + "\n"
  849. warning = False
  850. if ("completion" in progress) and ("printTime" in progress) and ("printTimeLeft" in progress) and (progress["completion"] != None) and (progress["printTime"] != None) and (progress["printTimeLeft"] != None):
  851. s += "%.1f%% Completion\n" % progress["completion"]
  852. s += "Printing since " + time.strftime("%H:%M:%S", time.gmtime(progress["printTime"])) + "\n"
  853. s += time.strftime("%H:%M:%S", time.gmtime(progress["printTimeLeft"])) + " left"
  854. elif ("completion" in progress) and ("printTime" in progress) and ("printTimeLeft" in progress):
  855. s += "No job is currently running"
  856. else:
  857. s += "Could not read printer status!"
  858. warning = True
  859. t = self.getTemperatureString(item[0], item[1])
  860. if len(t) > 0:
  861. s += "\n" + t
  862. self.showDialog("OctoTray Status", s, None, False, warning)
  863. def printerFilePrint(self, item, path):
  864. self.sendPostRequest(item[0], item[1], "files/" + path, '{ "command": "select", "print": true }')
  865. def setTemperature(self, host, key, what, temp):
  866. path = "printer/bed"
  867. s = "{\"command\": \"target\", \"target\": " + temp + "}"
  868. if "tool" in what:
  869. path = "printer/tool"
  870. s = "{\"command\": \"target\", \"targets\": {\"" + what + "\": " + temp + "}}"
  871. if temp == None:
  872. temp = 0
  873. self.sendPostRequest(host, key, path, s)
  874. def printerHeatTool(self, p):
  875. self.setTemperature(p[0], p[1], "tool0", p[2])
  876. def printerHeatBed(self, p):
  877. self.setTemperature(p[0], p[1], "bed", p[3])
  878. def printerCooldown(self, p):
  879. state = self.getState(p[0], p[1])
  880. if state in self.statesWithWarning:
  881. if self.showDialog("OctoTray Warning", "The printer seems to be running currently!", "Do you really want to turn it off?", True, True) == False:
  882. return
  883. self.setTemperature(p[0], p[1], "tool0", 0)
  884. self.setTemperature(p[0], p[1], "bed", 0)
  885. def printerWebcamAction(self, item):
  886. for cw in self.camWindows:
  887. if cw.getHost() == item[0]:
  888. cw.show()
  889. cw.activateWindow()
  890. return
  891. window = CamWindow(self, item)
  892. self.camWindows.append(window)
  893. window.show()
  894. window.activateWindow()
  895. screenGeometry = QDesktopWidget().screenGeometry()
  896. x = (screenGeometry.width() - window.width()) / 2
  897. y = (screenGeometry.height() - window.height()) / 2
  898. x += screenGeometry.x()
  899. y += screenGeometry.y()
  900. window.setGeometry(int(x), int(y), int(window.width()), int(window.height()))
  901. def removeWebcamWindow(self, window):
  902. self.camWindows.remove(window)
  903. def showSettingsAction(self):
  904. if self.settingsWindow != None:
  905. self.settingsWindow.show()
  906. self.settingsWindow.activateWindow()
  907. return
  908. self.settingsWindow = SettingsWindow(self)
  909. self.settingsWindow.show()
  910. self.settingsWindow.activateWindow()
  911. screenGeometry = QDesktopWidget().screenGeometry()
  912. x = (screenGeometry.width() - self.settingsWindow.width()) / 2
  913. y = (screenGeometry.height() - self.settingsWindow.height()) / 2
  914. x += screenGeometry.x()
  915. y += screenGeometry.y()
  916. self.settingsWindow.setGeometry(int(x), int(y), int(self.settingsWindow.width()), int(self.settingsWindow.height()) + 50)
  917. def removeSettingsWindow(self):
  918. self.settingsWindow = None
  919. def restartApp(self):
  920. QCoreApplication.exit(42)
  921. def closeAll(self):
  922. for cw in self.camWindows:
  923. cw.close()
  924. if self.settingsWindow != None:
  925. self.settingsWindow.close()
  926. if self.inSysTray:
  927. self.trayIcon.setVisible(False)
  928. else:
  929. self.mainWindow.setVisible(False)
  930. if __name__ == "__main__":
  931. app = QApplication(sys.argv)
  932. app.setQuitOnLastWindowClosed(False)
  933. signal.signal(signal.SIGINT, signal.SIG_DFL)
  934. inSysTray = QSystemTrayIcon.isSystemTrayAvailable()
  935. if ("windowed" in sys.argv) or ("--windowed" in sys.argv) or ("-w" in sys.argv):
  936. inSysTray = False
  937. tray = OctoTray(app, inSysTray)
  938. rc = app.exec_()
  939. while rc == 42:
  940. tray.closeAll()
  941. tray = OctoTray(app, inSysTray)
  942. rc = app.exec_()
  943. sys.exit(rc)