chiark / gitweb /
Add debug feature to watch and auto install firmware to easy firmware development.
[cura.git] / 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
9 from Cura.avr_isp import stk500v2
10 from Cura.avr_isp import ispBase
11 from Cura.avr_isp import intelHex
12
13 from Cura.gui.util import taskbar
14 from Cura.util import machineCom
15 from Cura.util import profile
16 from Cura.util import resources
17
18 def getDefaultFirmware(machineIndex = None):
19         if profile.getMachineSetting('machine_type', machineIndex) == 'ultimaker':
20                 name = 'MarlinUltimaker'
21                 if profile.getMachineSettingFloat('extruder_amount', machineIndex) > 2:
22                         return None
23                 if profile.getMachineSetting('has_heated_bed', machineIndex) == 'True':
24                         name += '-HBK'
25                 if sys.platform.startswith('linux'):
26                         name += '-115200'
27                 else:
28                         name += '-250000'
29                 if profile.getMachineSettingFloat('extruder_amount', machineIndex) > 1:
30                         name += '-dual'
31                 return resources.getPathForFirmware(name + '.hex')
32
33         if profile.getMachineSetting('machine_type', machineIndex) == 'ultimaker_plus':
34                 name = 'MarlinUltimaker-UMOP'
35                 if profile.getMachineSettingFloat('extruder_amount', machineIndex) > 2:
36                         return None
37                 if sys.platform.startswith('linux'):
38                         name += '-115200'
39                 else:
40                         name += '-250000'
41                 if profile.getMachineSettingFloat('extruder_amount', machineIndex) > 1:
42                         name += '-dual'
43                 return resources.getPathForFirmware(name + '.hex')
44
45         if profile.getMachineSetting('machine_type', machineIndex) == 'ultimaker2':
46                 return resources.getPathForFirmware("MarlinUltimaker2.hex")
47         if profile.getMachineSetting('machine_type', machineIndex) == 'Witbox':
48                 return resources.getPathForFirmware("MarlinWitbox.hex")
49         return None
50
51 class InstallFirmware(wx.Dialog):
52         def __init__(self, parent = None, filename = None, port = None, machineIndex = None):
53                 super(InstallFirmware, self).__init__(parent=parent, title="Firmware install for %s" % (profile.getMachineSetting('machine_name', machineIndex).title()), size=(250, 100))
54                 if port is None:
55                         port = profile.getMachineSetting('serial_port')
56                 if filename is None:
57                         filename = getDefaultFirmware(machineIndex)
58                 if filename is None:
59                         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)
60                         self.Destroy()
61                         return
62                 self._machine_type = profile.getMachineSetting('machine_type', machineIndex)
63                 if self._machine_type == 'reprap':
64                         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)
65
66                 sizer = wx.BoxSizer(wx.VERTICAL)
67
68                 self.progressLabel = wx.StaticText(self, -1, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nX\nX')
69                 sizer.Add(self.progressLabel, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
70                 self.progressGauge = wx.Gauge(self, -1)
71                 sizer.Add(self.progressGauge, 0, flag=wx.EXPAND)
72                 self.okButton = wx.Button(self, -1, _("OK"))
73                 self.okButton.Disable()
74                 self.okButton.Bind(wx.EVT_BUTTON, self.OnOk)
75                 sizer.Add(self.okButton, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
76                 self.SetSizer(sizer)
77
78                 self.filename = filename
79                 self.port = port
80
81                 self.Layout()
82                 self.Fit()
83
84                 self.thread = threading.Thread(target=self.OnRun)
85                 self.thread.daemon = True
86                 self.thread.start()
87
88                 self.ShowModal()
89                 self.Destroy()
90                 return
91
92         def OnRun(self):
93                 wx.CallAfter(self.updateLabel, _("Reading firmware..."))
94                 hexFile = intelHex.readHex(self.filename)
95                 wx.CallAfter(self.updateLabel, _("Connecting to machine..."))
96                 programmer = stk500v2.Stk500v2()
97                 programmer.progressCallback = self.OnProgress
98                 if self.port == 'AUTO':
99                         wx.CallAfter(self.updateLabel, _("Please connect the printer to\nyour computer with the USB cable."))
100                         while not programmer.isConnected():
101                                 for self.port in machineCom.serialList(True):
102                                         try:
103                                                 programmer.connect(self.port)
104                                                 break
105                                         except ispBase.IspError:
106                                                 pass
107                                 time.sleep(1)
108                                 if not self:
109                                         #Window destroyed
110                                         return
111                 else:
112                         try:
113                                 programmer.connect(self.port)
114                         except ispBase.IspError:
115                                 pass
116
117                 if not programmer.isConnected():
118                         wx.MessageBox(_("Failed to find machine for firmware upgrade\nIs your machine connected to the PC?"),
119                                                   _("Firmware update"), wx.OK | wx.ICON_ERROR)
120                         wx.CallAfter(self.Close)
121                         return
122
123                 if self._machine_type == 'ultimaker':
124                         if programmer.hasChecksumFunction():
125                                 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+?"))
126                                 programmer.close()
127                                 wx.CallAfter(self.okButton.Enable)
128                                 return
129                 if self._machine_type == 'ultimaker_plus' or self._machine_type == 'ultimaker2':
130                         if not programmer.hasChecksumFunction():
131                                 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?"))
132                                 programmer.close()
133                                 wx.CallAfter(self.okButton.Enable)
134                                 return
135
136                 wx.CallAfter(self.updateLabel, _("Uploading firmware..."))
137                 try:
138                         programmer.programChip(hexFile)
139                         wx.CallAfter(self.updateLabel, _("Done!\nInstalled firmware: %s") % (os.path.basename(self.filename)))
140                 except ispBase.IspError as e:
141                         wx.CallAfter(self.updateLabel, _("Failed to write firmware.\n") + str(e))
142
143                 programmer.close()
144                 wx.CallAfter(self.okButton.Enable)
145
146         def updateLabel(self, text):
147                 self.progressLabel.SetLabel(text)
148                 #self.Layout()
149
150         def OnProgress(self, value, max):
151                 wx.CallAfter(self.progressGauge.SetRange, max)
152                 wx.CallAfter(self.progressGauge.SetValue, value)
153                 taskbar.setProgress(self.GetParent(), value, max)
154
155         def OnOk(self, e):
156                 self.Close()
157                 taskbar.setBusy(self.GetParent(), False)
158
159         def OnClose(self, e):
160                 self.Destroy()
161
162
163 class AutoUpdateFirmware(wx.Dialog):
164         def __init__(self, parent, filename = None, port = None, machineIndex = None):
165                 super(AutoUpdateFirmware, self).__init__(parent=parent, title="Auto Firmware install", size=(250, 100))
166                 if port is None:
167                         port = profile.getMachineSetting('serial_port')
168
169                 sizer = wx.BoxSizer(wx.VERTICAL)
170
171                 self.progressLabel = wx.StaticText(self, -1, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nX\nX')
172                 sizer.Add(self.progressLabel, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
173                 self.progressGauge = wx.Gauge(self, -1)
174                 sizer.Add(self.progressGauge, 0, flag=wx.EXPAND)
175                 self.okButton = wx.Button(self, -1, _("OK"))
176                 self.okButton.Bind(wx.EVT_BUTTON, self.OnOk)
177                 sizer.Add(self.okButton, 0, flag=wx.ALIGN_CENTER|wx.ALL, border=5)
178                 self.SetSizer(sizer)
179
180                 self.filename = filename
181                 self.port = port
182
183                 self.Layout()
184                 self.Fit()
185
186                 self.thread = threading.Thread(target=self.OnRun)
187                 self.thread.daemon = True
188                 self.thread.start()
189
190                 self.ShowModal()
191                 self.Destroy()
192                 return
193
194         def OnRun(self):
195                 mtime = 0
196                 while bool(self):
197                         new_mtime = os.stat(self.filename).st_mtime
198                         if mtime != new_mtime:
199                                 mtime = new_mtime
200                                 time.sleep(0.5)
201                                 self.OnInstall()
202                         time.sleep(0.5)
203
204         def OnInstall(self):
205                 wx.CallAfter(self.okButton.Disable)
206                 wx.CallAfter(self.updateLabel, _("Reading firmware..."))
207                 hexFile = intelHex.readHex(self.filename)
208                 wx.CallAfter(self.updateLabel, _("Connecting to machine..."))
209                 programmer = stk500v2.Stk500v2()
210                 programmer.progressCallback = self.OnProgress
211                 if self.port == 'AUTO':
212                         wx.CallAfter(self.updateLabel, _("Please connect the printer to\nyour computer with the USB cable."))
213                         while not programmer.isConnected():
214                                 for self.port in machineCom.serialList(True):
215                                         try:
216                                                 programmer.connect(self.port)
217                                                 break
218                                         except ispBase.IspError:
219                                                 pass
220                                 time.sleep(1)
221                                 if not self:
222                                         #Window destroyed
223                                         return
224                 else:
225                         try:
226                                 programmer.connect(self.port)
227                         except ispBase.IspError:
228                                 pass
229
230                 if not programmer.isConnected():
231                         wx.CallAfter(self.updateLabel, _("Failed to connect to programmer.\n"))
232                         return
233
234                 wx.CallAfter(self.updateLabel, _("Uploading firmware..."))
235                 try:
236                         programmer.programChip(hexFile)
237                         wx.CallAfter(self.updateLabel, _("Done!\nInstalled firmware: %s") % (os.path.basename(self.filename)))
238                 except ispBase.IspError as e:
239                         wx.CallAfter(self.updateLabel, _("Failed to write firmware.\n") + str(e))
240
241                 programmer.close()
242                 wx.CallAfter(self.okButton.Enable)
243
244         def updateLabel(self, text):
245                 self.progressLabel.SetLabel(text)
246                 #self.Layout()
247
248         def OnProgress(self, value, max):
249                 wx.CallAfter(self.progressGauge.SetRange, max)
250                 wx.CallAfter(self.progressGauge.SetValue, value)
251                 taskbar.setProgress(self.GetParent(), value, max)
252
253         def OnOk(self, e):
254                 self.Close()
255                 taskbar.setBusy(self.GetParent(), False)
256
257         def OnClose(self, e):
258                 self.Destroy()
259