Cura/gui/firmwareInstall.py

   1 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
   2
   3 import os
   4 import wx
   5 import threading
   6 import sys
   7 import time
   8 import serial
   9
  10 from Cura.avr_isp import stk500v2
  11 from Cura.avr_isp import ispBase
  12 from Cura.avr_isp import intelHex
  13
  14 from Cura.gui.util import taskbar
  15 from Cura.util import machineCom
  16 from Cura.util import profile
  17 from Cura.util import resources
  18
  19 def getDefaultFirmware(machineIndex = None):
  20         firmwareDict = {
  21                         'ultimaker2go':"MarlinUltimaker2go.hex",
  22                         'Witbox':"MarlinWitbox.hex",
  23                         'lulzbot_mini': "Mini-Single-or-Flexystruder-LBHexagon-2015Q2.hex",
  24                         'lulzbot_mini_flexystruder': "Mini-Single-or-Flexystruder-LBHexagon-2015Q2.hex",
  25                         'lulzbot_TAZ_4_SingleV1': "Taz4-5-Single-or-Flexystruder-Budaschnozzle-2014Q3.hex",
  26                         'lulzbot_TAZ_5_SingleV1': "Taz4-5-Single-or-Flexystruder-Budaschnozzle-2014Q3.hex",
  27                         'lulzbot_TAZ_4_05nozzle': "Taz4-Single-Extruder-LBHexagon-2015Q3.hex",
  28                         'lulzbot_TAZ_5_05nozzle': "Taz5-Single-Extruder-LBHexagon-2015Q2.hex",
  29                         'lulzbot_TAZ_4_035nozzle': "Taz4-Single-Extruder-LBHexagon-2015Q3.hex",
  30                         'lulzbot_TAZ_5_035nozzle': "Taz5-Single-Extruder-LBHexagon-2015Q2.hex",
  31                         'lulzbot_TAZ_4_FlexystruderV1': "Taz4-5-Single-or-Flexystruder-Budaschnozzle-2014Q3.hex",
  32                         'lulzbot_TAZ_5_FlexystruderV1': "Taz4-5-Single-or-Flexystruder-Budaschnozzle-2014Q3.hex",
  33                         'lulzbot_TAZ_4_FlexystruderV2': "Taz4-5-Flexystruder-LBHexagon-2015Q3.hex",
  34                         'lulzbot_TAZ_5_FlexystruderV2': "Taz4-5-Flexystruder-LBHexagon-2015Q3.hex",
  35                         'lulzbot_TAZ_4_DualV1': "Taz4-5-Dual-or-FlexyDually-Budaschnozzle-2015Q1.hex",
  36                         'lulzbot_TAZ_5_DualV1': "Taz4-5-Dual-or-FlexyDually-Budaschnozzle-2015Q1.hex",
  37                         'lulzbot_TAZ_4_DualV2': "Taz4-5-Dual-LBHexagon-2015Q3.hex",
  38                         'lulzbot_TAZ_5_DualV2': "Taz4-5-Dual-LBHexagon-2015Q3.hex",
  39                         'lulzbot_TAZ_4_FlexyDuallyV1': "Taz4-5-Dual-or-FlexyDually-Budaschnozzle-2015Q1.hex",
  40                         'lulzbot_TAZ_5_FlexyDuallyV1': "Taz4-5-Dual-or-FlexyDually-Budaschnozzle-2015Q1.hex",
  41                         'lulzbot_TAZ_4_FlexyDuallyV2': "Taz4-5-FlexyDually-LBHexagon-2015Q3.hex",
  42                         'lulzbot_TAZ_5_FlexyDuallyV2': "Taz4-5-FlexyDually-LBHexagon-2015Q3.hex"
  43         }
  44         machine_type = profile.getMachineSetting('machine_type', machineIndex)
  45         extruders = profile.getMachineSettingFloat('extruder_amount', machineIndex)
  46         heated_bed = profile.getMachineSetting('has_heated_bed', machineIndex) == 'True'
  47         baudrate = 250000
  48         if sys.platform.startswith('linux'):
  49                 baudrate = 115200
  50         if machine_type == 'ultimaker':
  51                 name = 'MarlinUltimaker'
  52                 if extruders > 2:
  53                         return None
  54                 if heated_bed:
  55                         name += '-HBK'
  56                 name += '-%d' % (baudrate)
  57                 if extruders > 1:
  58                         name += '-dual'
  59                 return resources.getPathForFirmware(name + '.hex')
  60
  61         if machine_type == 'ultimaker_plus':
  62                 name = 'MarlinUltimaker-UMOP-%d' % (baudrate)
  63                 if extruders > 2:
  64                         return None
  65                 if extruders > 1:
  66                         name += '-dual'
  67                 return resources.getPathForFirmware(name + '.hex')
  68         if machine_type == 'ultimaker2':
  69                 if extruders > 2:
  70                         return None
  71                 if extruders > 1:
  72                         return resources.getPathForFirmware("MarlinUltimaker2-dual.hex")
  73                 return resources.getPathForFirmware("MarlinUltimaker2.hex")
  74         if machine_type == 'ultimaker2extended':
  75                 if extruders > 2:
  76                         return None
  77                 if extruders > 1:
  78                         return resources.getPathForFirmware("MarlinUltimaker2extended-dual.hex")
  79                 return resources.getPathForFirmware("MarlinUltimaker2extended.hex")
  80         if firmwareDict.has_key(machine_type):
  81                 return resources.getPathForFirmware(firmwareDict[machine_type])
  82         return None
  83
  84 def InstallFirmware(parent = None, filename = None, port = None, machineIndex = None):
  85         dlg = InstallFirmwareDialog(parent, filename, port, machineIndex)
  86         result = dlg.Run()
  87         dlg.Destroy()
  88         return result
  89
  90 class InstallFirmwareDialog(wx.Dialog):
  91         def __init__(self, parent = None, filename = None, port = None, machineIndex = None):
  92                 super(InstallFirmwareDialog, self).__init__(parent=parent, title=_("Firmware install for %s") % (profile.getMachineName(machineIndex).title()), size=(250, 100))
  93                 if port is None:
  94                         port = profile.getMachineSetting('serial_port')
  95                 if filename is None:
  96                         filename = getDefaultFirmware(machineIndex)
  97                 if filename is None:
  98                         wx.MessageBox(_("I am sorry, but Cura does not ship with a default firmware for your machine configuration."), _("Firmware update"), wx.OK | wx.ICON_ERROR)
  99                         self.Destroy()
 100                         return
 101                 self._machine_type = profile.getMachineSetting('machine_type', machineIndex)
 102                 if self._machine_type == 'reprap':
 103                         wx.MessageBox(_("Cura only supports firmware updates for ATMega2560 based hardware.\nSo updating your RepRap with Cura might or might not work."), _("Firmware update"), wx.OK | wx.ICON_INFORMATION)
 104
 105                 sizer = wx.BoxSizer(wx.VERTICAL)
 106
 107                 self.progressLabel = wx.StaticText(self, -1, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nX\nX')
 108                 sizer.Add(self.progressLabel, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
 109                 self.progressGauge = wx.Gauge(self, -1)
 110                 sizer.Add(self.progressGauge, 0, flag=wx.EXPAND)
 111                 self.okButton = wx.Button(self, -1, _("OK"))
 112                 self.okButton.Disable()
 113                 self.okButton.Bind(wx.EVT_BUTTON, self.OnOk)
 114                 sizer.Add(self.okButton, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
 115                 self.SetSizer(sizer)
 116
 117                 self.filename = filename
 118                 self.port = port
 119
 120                 self.Layout()
 121                 self.Fit()
 122                 self.success = False
 123
 124         def Run(self):
 125                 self.success = False
 126                 self.thread = threading.Thread(target=self.OnRun)
 127                 self.thread.daemon = True
 128                 self.thread.start()
 129
 130                 self.ShowModal()
 131                 return self.success
 132
 133         def OnRun(self):
 134                 wx.CallAfter(self.updateLabel, _("Reading firmware..."))
 135                 hexFile = intelHex.readHex(self.filename)
 136                 wx.CallAfter(self.updateLabel, _("Connecting to machine..."))
 137                 programmer = stk500v2.Stk500v2()
 138                 programmer.progressCallback = self.OnProgress
 139                 if self.port == 'AUTO':
 140                         wx.CallAfter(self.updateLabel, _("Please connect the printer to\nyour computer with the USB cable."))
 141                         while not programmer.isConnected():
 142                                 for self.port in machineCom.serialList(True):
 143                                         try:
 144                                                 programmer.connect(self.port)
 145                                                 break
 146                                         except ispBase.IspError:
 147                                                 programmer.close()
 148                                 time.sleep(1)
 149                                 if not self:
 150                                         #Window destroyed
 151                                         return
 152                 else:
 153                         try:
 154                                 programmer.connect(self.port)
 155                         except ispBase.IspError:
 156                                 programmer.close()
 157
 158                 if not programmer.isConnected():
 159                         wx.MessageBox(_("Failed to find machine for firmware upgrade\nIs your machine connected to the PC?"),
 160                                                   _("Firmware update"), wx.OK | wx.ICON_ERROR)
 161                         wx.CallAfter(self.Close)
 162                         return
 163
 164                 if self._machine_type == 'ultimaker':
 165                         if programmer.hasChecksumFunction():
 166                                 wx.CallAfter(self.updateLabel, _("Failed to install firmware:\nThis firmware is not compatible with this machine.\nTrying to install UMO firmware on an UM2 or UMO+?"))
 167                                 programmer.close()
 168                                 wx.CallAfter(self.okButton.Enable)
 169                                 return
 170                 if self._machine_type == 'ultimaker_plus' or self._machine_type == 'ultimaker2':
 171                         if not programmer.hasChecksumFunction():
 172                                 wx.CallAfter(self.updateLabel, _("Failed to install firmware:\nThis firmware is not compatible with this machine.\nTrying to install UM2 or UMO+ firmware on an UMO?"))
 173                                 programmer.close()
 174                                 wx.CallAfter(self.okButton.Enable)
 175                                 return
 176
 177                 wx.CallAfter(self.updateLabel, _("Uploading firmware..."))
 178                 try:
 179                         programmer.programChip(hexFile)
 180                         self.success = True
 181                         wx.CallAfter(self.updateLabel, _("Done!\nInstalled firmware: %s") % (os.path.basename(self.filename)))
 182                 except ispBase.IspError as e:
 183                         wx.CallAfter(self.updateLabel, _("Failed to write firmware.\n") + str(e))
 184
 185                 programmer.close()
 186                 wx.CallAfter(self.okButton.Enable)
 187
 188         def updateLabel(self, text):
 189                 self.progressLabel.SetLabel(text)
 190                 #self.Layout()
 191
 192         def OnProgress(self, value, max):
 193                 if self:
 194                         wx.CallAfter(self.progressGauge.SetRange, max)
 195                         wx.CallAfter(self.progressGauge.SetValue, value)
 196                         taskbar.setProgress(self.GetParent(), value, max)
 197
 198         def OnOk(self, e):
 199                 self.Close()
 200                 taskbar.setBusy(self.GetParent(), False)
 201
 202         def OnClose(self, e):
 203                 self.Destroy()
 204
 205
 206 class AutoUpdateFirmware(wx.Dialog):
 207         def __init__(self, parent, filename = None, port = None, machineIndex = None):
 208                 super(AutoUpdateFirmware, self).__init__(parent=parent, title=_("Auto Firmware install"), size=(250, 500))
 209                 if port is None:
 210                         port = profile.getMachineSetting('serial_port')
 211                 self._serial = None
 212
 213                 sizer = wx.BoxSizer(wx.VERTICAL)
 214
 215                 self.progressLabel = wx.StaticText(self, -1, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nX\nX')
 216                 sizer.Add(self.progressLabel, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
 217                 self.progressGauge = wx.Gauge(self, -1)
 218                 sizer.Add(self.progressGauge, 0, flag=wx.EXPAND)
 219                 self.okButton = wx.Button(self, -1, _("OK"))
 220                 self.okButton.Bind(wx.EVT_BUTTON, self.OnOk)
 221                 sizer.Add(self.okButton, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
 222
 223                 f = wx.Font(8, wx.FONTFAMILY_MODERN, wx.FONTSTYLE_NORMAL, wx.FONTWEIGHT_NORMAL, False)
 224                 self._termLog = wx.TextCtrl(self, style=wx.TE_MULTILINE | wx.TE_DONTWRAP)
 225                 self._termLog.SetFont(f)
 226                 self._termLog.SetEditable(0)
 227                 self._termLog.SetMinSize((1, 400))
 228                 self._termInput = wx.TextCtrl(self, style=wx.TE_PROCESS_ENTER)
 229                 self._termInput.SetFont(f)
 230                 sizer.Add(self._termLog, 0, flag=wx.ALIGN_CENTER|wx.ALL|wx.EXPAND)
 231                 sizer.Add(self._termInput, 0, flag=wx.ALIGN_CENTER|wx.ALL|wx.EXPAND)
 232
 233                 self.Bind(wx.EVT_TEXT_ENTER, self.OnTermEnterLine, self._termInput)
 234
 235                 self.SetSizer(sizer)
 236
 237                 self.filename = filename
 238                 self.port = port
 239
 240                 self.Layout()
 241                 self.Fit()
 242
 243                 self.thread = threading.Thread(target=self.OnRun)
 244                 self.thread.daemon = True
 245                 self.thread.start()
 246
 247                 self.read_thread = threading.Thread(target=self.OnSerialRead)
 248                 self.read_thread.daemon = True
 249                 self.read_thread.start()
 250
 251                 self.ShowModal()
 252                 self.Destroy()
 253                 return
 254
 255         def _addTermLog(self, line):
 256                 if self._termLog is not None:
 257                         if len(self._termLog.GetValue()) > 10000:
 258                                 self._termLog.SetValue(self._termLog.GetValue()[-10000:])
 259                         self._termLog.SetInsertionPointEnd()
 260                         if type(line) != unicode:
 261                                 line = unicode(line, 'utf-8', 'replace')
 262                         self._termLog.AppendText(line.encode('utf-8', 'replace'))
 263
 264         def OnTermEnterLine(self, e):
 265                 lines = self._termInput.GetValue().split(';')
 266                 for line in lines:
 267                         if line == '':
 268                                 continue
 269                         self._addTermLog('> %s\n' % (line))
 270                         if self._serial is not None:
 271                                 self._serial.write(line + '\n')
 272
 273         def OnRun(self):
 274                 mtime = 0
 275                 while bool(self):
 276                         new_mtime = os.stat(self.filename).st_mtime
 277                         if mtime != new_mtime:
 278                                 mtime = new_mtime
 279                                 if self._serial is not None:
 280                                         self._serial.close()
 281                                         self._serial = None
 282                                 time.sleep(0.5)
 283                                 self.OnInstall()
 284                                 try:
 285                                         self._serial = serial.Serial(self.port, 115200)
 286                                 except:
 287                                         pass
 288                         time.sleep(0.5)
 289
 290         def OnSerialRead(self):
 291                 while bool(self):
 292                         if self._serial is None:
 293                                 time.sleep(0.5)
 294                         else:
 295                                 try:
 296                                         line = self._serial.readline()
 297                                         wx.CallAfter(self._addTermLog, line)
 298                                 except:
 299                                         pass
 300
 301         def OnInstall(self):
 302                 wx.CallAfter(self.okButton.Disable)
 303                 wx.CallAfter(self.updateLabel, _("Reading firmware..."))
 304                 hexFile = intelHex.readHex(self.filename)
 305                 wx.CallAfter(self.updateLabel, _("Connecting to machine..."))
 306                 programmer = stk500v2.Stk500v2()
 307                 programmer.progressCallback = self.OnProgress
 308                 if self.port == 'AUTO':
 309                         wx.CallAfter(self.updateLabel, _("Please connect the printer to\nyour computer with the USB cable."))
 310                         while not programmer.isConnected():
 311                                 for self.port in machineCom.serialList(True):
 312                                         try:
 313                                                 programmer.connect(self.port)
 314                                                 break
 315                                         except ispBase.IspError:
 316                                                 pass
 317                                 time.sleep(1)
 318                                 if not self:
 319                                         #Window destroyed
 320                                         return
 321                 else:
 322                         try:
 323                                 programmer.connect(self.port)
 324                         except ispBase.IspError:
 325                                 pass
 326
 327                 if not programmer.isConnected():
 328                         wx.CallAfter(self.updateLabel, _("Failed to connect to programmer.\n"))
 329                         return
 330
 331                 wx.CallAfter(self.updateLabel, _("Uploading firmware..."))
 332                 try:
 333                         programmer.programChip(hexFile)
 334                         wx.CallAfter(self.updateLabel, _("Done!\nInstalled firmware: %s") % (os.path.basename(self.filename)))
 335                 except ispBase.IspError as e:
 336                         wx.CallAfter(self.updateLabel, _("Failed to write firmware.\n") + str(e))
 337
 338                 programmer.close()
 339                 wx.CallAfter(self.okButton.Enable)
 340
 341         def updateLabel(self, text):
 342                 self.progressLabel.SetLabel(text)
 343                 #self.Layout()
 344
 345         def OnProgress(self, value, max):
 346                 wx.CallAfter(self.progressGauge.SetRange, max)
 347                 wx.CallAfter(self.progressGauge.SetValue, value)
 348                 taskbar.setProgress(self.GetParent(), value, max)
 349
 350         def OnOk(self, e):
 351                 self.Close()
 352                 taskbar.setBusy(self.GetParent(), False)
 353
 354         def OnClose(self, e):
 355                 self.Destroy()
 356