Add xmodem uploading
This commit is contained in:
Julian Kent
parent
7a34e6640a
commit
6c818a2068
@ -4,11 +4,16 @@ import threading
|
||||
from string import printable
|
||||
|
||||
from PyQt4 import QtCore, QtGui, QtWebKit
|
||||
from serial import Serial, SerialException, serial_for_url
|
||||
from serial import SerialException, serial_for_url
|
||||
from select import error as SelectError
|
||||
from socket import error as SocketError
|
||||
import time
|
||||
from os.path import getsize
|
||||
|
||||
from colourterm import SettingsDialog, ConnectDialog, SComboBox, Highlight, from_utf8, translate, \
|
||||
create_default_highlights
|
||||
from colourterm.cwebview import CWebView
|
||||
from colourterm.xmodem import XMODEM1k, XMODEM
|
||||
|
||||
|
||||
class MessageType(object):
|
||||
@ -37,6 +42,7 @@ class UiMainWindow(object):
|
||||
self.open_action = None
|
||||
self.close_action = None
|
||||
self.capture_action = None
|
||||
self.xmodem_action = None
|
||||
self.follow_action = None
|
||||
self.configure_action = None
|
||||
self.exit_action = None
|
||||
@ -155,6 +161,15 @@ class UiMainWindow(object):
|
||||
self.clear_action.setIcon(clear_icon)
|
||||
self.clear_action.setObjectName(from_utf8('clear_action'))
|
||||
self.clear_action.setShortcut(QtGui.QKeySequence(QtCore.Qt.CTRL + QtCore.Qt.Key_Backspace))
|
||||
|
||||
self.xmodem_action = QtGui.QAction(main_window)
|
||||
xmodem_icon = QtGui.QIcon()
|
||||
xmodem_icon.addPixmap(QtGui.QPixmap(from_utf8(':/toolbar/move-up.png')),
|
||||
QtGui.QIcon.Normal, QtGui.QIcon.Off)
|
||||
self.xmodem_action.setIcon(xmodem_icon)
|
||||
self.xmodem_action.setObjectName(from_utf8('xmodem_action'))
|
||||
self.xmodem_action.setShortcut(QtGui.QKeySequence(QtCore.Qt.CTRL + QtCore.Qt.SHIFT + QtCore.Qt.Key_X))
|
||||
|
||||
self.configure_action = QtGui.QAction(main_window)
|
||||
configure_icon = QtGui.QIcon()
|
||||
configure_icon.addPixmap(QtGui.QPixmap(from_utf8(':/toolbar/configure.png')),
|
||||
@ -174,6 +189,7 @@ class UiMainWindow(object):
|
||||
self.tool_bar.addAction(self.capture_action)
|
||||
self.tool_bar.addAction(self.follow_action)
|
||||
self.tool_bar.addAction(self.clear_action)
|
||||
self.tool_bar.addAction(self.xmodem_action)
|
||||
self.tool_bar.addSeparator()
|
||||
self.tool_bar.addAction(self.configure_action)
|
||||
self.tool_bar.addAction(self.exit_action)
|
||||
@ -202,6 +218,8 @@ class UiMainWindow(object):
|
||||
self.follow_action.setToolTip(translate('MainWindow', 'Follow (Ctrl+Shift+F)'))
|
||||
self.clear_action.setText(translate('MainWindow', 'Clear'))
|
||||
self.clear_action.setToolTip(translate('MainWindow', 'Clear (Ctrl+BkSpace)'))
|
||||
self.xmodem_action.setText(translate('MainWindow', 'Xmodem'))
|
||||
self.xmodem_action.setToolTip(translate('MainWindow', 'Send a file via Xmodem (Ctrl+Shift+X)'))
|
||||
self.configure_action.setText(translate('MainWindow', 'Configure...'))
|
||||
self.configure_action.setToolTip(translate('MainWindow', 'Configure...'))
|
||||
self.exit_action.setText(translate('MainWindow', 'Exit'))
|
||||
@ -223,6 +241,8 @@ class MainWindow(QtGui.QMainWindow, UiMainWindow):
|
||||
self.capture_file = None
|
||||
self.capture_filename = u''
|
||||
self.highlights = self.load_highlights()
|
||||
self.disable_output = False
|
||||
self.xmodem_send_progress_window = None
|
||||
if not self.highlights:
|
||||
self.highlights = create_default_highlights()
|
||||
self.settings_dialog = SettingsDialog()
|
||||
@ -233,6 +253,7 @@ class MainWindow(QtGui.QMainWindow, UiMainWindow):
|
||||
self.capture_action.toggled.connect(self.on_capture_action_toggled)
|
||||
self.follow_action.toggled.connect(self.on_follow_action_toggled)
|
||||
self.clear_action.triggered.connect(self.on_clear_action_triggered)
|
||||
self.xmodem_action.triggered.connect(self.on_xmodem_action_triggered)
|
||||
self.configure_action.triggered.connect(self.on_configure_action_triggered)
|
||||
self.exit_action.triggered.connect(self.close)
|
||||
self.find_combobox.keyPressed.connect(self.on_find_combobox_key_pressed)
|
||||
@ -258,6 +279,9 @@ class MainWindow(QtGui.QMainWindow, UiMainWindow):
|
||||
output = ''
|
||||
while not self.device_closed:
|
||||
try:
|
||||
if self.disable_output:
|
||||
time.sleep(0.5)
|
||||
continue
|
||||
output += self.device.read(1)
|
||||
except SerialException as e:
|
||||
self.showMessage.emit(u'Port Error', u'Error reading from serial port: %s' % e, MessageType.Critical)
|
||||
@ -360,6 +384,37 @@ class MainWindow(QtGui.QMainWindow, UiMainWindow):
|
||||
element.removeFromDocument()
|
||||
del elements
|
||||
|
||||
def xmodem_callback(self, total_packets, success_count, error_count):
|
||||
if self.xmodem_send_progress_window:
|
||||
self.xmodem_send_progress_window.setValue(success_count)
|
||||
print total_packets, success_count, error_count
|
||||
|
||||
def on_xmodem_action_triggered(self):
|
||||
file_dialog = QtGui.QFileDialog()
|
||||
if file_dialog.exec_():
|
||||
self.disable_output = True
|
||||
try:
|
||||
upload_file = file_dialog.selectedFiles()[0]
|
||||
file_size = getsize(upload_file)
|
||||
self.device.flushInput()
|
||||
self.device.flushOutput()
|
||||
xmodem_transfer = XMODEM(self.getc, self.putc, mode='xmodem1k', pad='\xff')
|
||||
stream = open(upload_file, 'rb')
|
||||
self.xmodem_send_progress_window = QtGui.QProgressDialog(u'Sending File...', u'', 0, 0)
|
||||
self.xmodem_send_progress_window.setCancelButton(None)
|
||||
self.xmodem_send_progress_window.setMinimum(0)
|
||||
self.xmodem_send_progress_window.setMaximum(file_size/1024)
|
||||
self.xmodem_send_progress_window.setValue(0)
|
||||
self.xmodem_send_progress_window.setModal(True)
|
||||
self.xmodem_send_progress_window.show()
|
||||
success = xmodem_transfer.send(stream, retry=200, callback=self.xmodem_callback)
|
||||
print success
|
||||
finally:
|
||||
if self.xmodem_send_progress_window:
|
||||
self.xmodem_send_progress_window.close()
|
||||
self.xmodem_send_progress_window = None
|
||||
self.disable_output = False
|
||||
|
||||
def on_configure_action_triggered(self):
|
||||
self.settings_dialog.set_highlights(self.highlights)
|
||||
self.settings_dialog.exec_()
|
||||
@ -497,3 +552,47 @@ class MainWindow(QtGui.QMainWindow, UiMainWindow):
|
||||
settings.endGroup()
|
||||
highlights.append(Highlight(pattern, foreground, background))
|
||||
return highlights
|
||||
|
||||
def getc(self, size, timeout=1):
|
||||
"""
|
||||
Read a byte (usually a character) from the serial port
|
||||
|
||||
:param timeout:
|
||||
:param size:
|
||||
"""
|
||||
try:
|
||||
data = self.device.read(size)
|
||||
except SerialException as se:
|
||||
if 'interrupted system call' in str(se.args[0]).lower():
|
||||
data = self.device.read(size)
|
||||
else:
|
||||
raise Exception(str(se))
|
||||
except (SelectError, SocketError) as se:
|
||||
if se.args[0] == 4:
|
||||
data = self.device.read(size)
|
||||
else:
|
||||
raise Exception(str(se))
|
||||
return data or None
|
||||
|
||||
def putc(self, data, timeout=1):
|
||||
"""
|
||||
Send a byte (usually a character) to the serial port
|
||||
|
||||
:param timeout:
|
||||
:param data:
|
||||
"""
|
||||
try:
|
||||
self.device.write(data)
|
||||
except SerialException as se:
|
||||
self.error(u'Got a SerialException: %s', se)
|
||||
if 'interrupted system call' in str(se.args[0]).lower():
|
||||
self.device.write(data)
|
||||
else:
|
||||
raise Exception(str(se))
|
||||
except (SelectError, SocketError) as se:
|
||||
if se.args[0] == 4:
|
||||
self.device.write(data)
|
||||
else:
|
||||
self.error(u'Got a SocketError or SelectError: %s', se)
|
||||
raise Exception(str(se))
|
||||
return None
|
||||
@ -2,8 +2,8 @@
|
||||
|
||||
# Resource object code
|
||||
#
|
||||
# Created: Fri Apr 4 14:42:39 2014
|
||||
# by: The Resource Compiler for PyQt (Qt v4.8.4)
|
||||
# Created: Thu Mar 12 15:34:18 2015
|
||||
# by: The Resource Compiler for PyQt (Qt v4.8.6)
|
||||
#
|
||||
# WARNING! All changes made in this file will be lost!
|
||||
|
||||
@ -533,6 +533,50 @@ qt_resource_data = "\
|
||||
\x27\xba\xa5\x6b\x0f\xed\x05\x01\x21\x49\x47\x35\x4b\xf2\x33\x1b\
|
||||
\xbe\xcc\x2e\x6b\x7d\xff\xbf\x37\xef\x0f\x9a\xca\x63\x9c\x02\x93\
|
||||
\x79\xca\x00\x00\x00\x00\x49\x45\x4e\x44\xae\x42\x60\x82\
|
||||
\x00\x00\x02\xa0\
|
||||
\x89\
|
||||
\x50\x4e\x47\x0d\x0a\x1a\x0a\x00\x00\x00\x0d\x49\x48\x44\x52\x00\
|
||||
\x00\x00\x10\x00\x00\x00\x10\x08\x06\x00\x00\x00\x1f\xf3\xff\x61\
|
||||
\x00\x00\x00\x06\x62\x4b\x47\x44\x00\xff\x00\xff\x00\xff\xa0\xbd\
|
||||
\xa7\x93\x00\x00\x00\x09\x70\x48\x59\x73\x00\x00\x03\x76\x00\x00\
|
||||
\x03\x76\x01\x7d\xd5\x82\xcc\x00\x00\x00\x07\x74\x49\x4d\x45\x07\
|
||||
\xd7\x0c\x1d\x0d\x11\x0d\x81\xdc\x28\x8a\x00\x00\x02\x2d\x49\x44\
|
||||
\x41\x54\x78\xda\x8d\x92\x4b\x6b\x53\x41\x18\x86\xdf\x99\x73\x89\
|
||||
\x39\x27\x27\xd5\xa8\xb9\x94\x6e\x52\x53\xdb\x8d\xd5\x58\xaa\xe2\
|
||||
\x05\x74\x97\x85\x05\x05\x0b\xd5\xba\xf0\x07\x08\xf5\x27\x88\x22\
|
||||
\x88\x1b\x11\x14\x5d\x58\x14\x29\x2d\xd9\x88\x6e\x04\xc1\x85\x8b\
|
||||
\xea\xca\x85\x0b\x15\x5d\x18\xa4\x55\xc4\xa0\x6d\x9a\x73\x92\x9c\
|
||||
\xcb\x5c\x9c\xb4\xb8\x90\xc6\x98\x81\x6f\xf3\xcd\xfb\x3d\xcc\xf3\
|
||||
\x31\xe8\x76\x0a\x93\x0f\xae\xe5\x4f\xdd\xb9\xd2\x2d\xa3\xfd\xeb\
|
||||
\x62\x68\x6a\xae\x94\xb4\xc8\x3d\x03\xfe\x31\x23\x7b\xe8\x75\xbd\
|
||||
\xf2\xb2\xd2\x29\x47\x3b\x35\x77\x9f\x9d\xcf\x10\xc9\x1f\x4e\x9d\
|
||||
\x1c\x21\xe7\x4e\x8f\x51\xc9\xfd\x47\x99\xc3\x33\x3b\x7b\x02\x0c\
|
||||
\x4f\x97\x89\x54\xc3\x63\x23\x4e\x26\x69\x6b\xd8\x9a\x8c\xe1\xc8\
|
||||
\xf8\xae\x9c\x60\xfe\x6c\x6a\xdf\xf9\xff\x03\x84\x60\x97\xb6\xd9\
|
||||
\x28\x8d\x0e\xa7\xe0\xae\x35\x50\x57\x55\x1c\x1d\x44\x36\xdd\x37\
|
||||
\x01\xc1\x2f\x76\xdd\x81\xf2\x2e\x12\x19\x2e\x1c\x2f\xa6\x74\x53\
|
||||
\xd7\xc0\xb9\x40\xc4\x04\xc2\x90\x23\x97\xdd\x8e\x0f\xef\x3f\x9e\
|
||||
\xd0\xfb\x06\x9f\x06\x3f\x3f\x55\x37\xbd\x20\x3f\x71\xd3\x09\x6a\
|
||||
\xcb\xe5\x42\x86\xc5\x62\xa6\x8e\x20\x94\xaa\x80\xb0\x5d\x11\x60\
|
||||
\x98\x71\x8c\x1f\xd8\x1f\x57\x7a\xf3\x89\x42\x69\xcb\x26\x40\x58\
|
||||
\xff\x76\x37\x41\x6b\x43\x03\xb9\x14\x42\x06\x30\x41\xc1\xa5\x86\
|
||||
\x48\x68\xa8\xb9\x0c\x5f\x96\x6b\xf8\xb5\x26\x11\xb3\x9c\x3d\x52\
|
||||
\xb0\xeb\x7f\x29\xe4\x8e\xce\x4c\x46\xee\x8f\xab\xb9\xfe\x7e\x10\
|
||||
\x3d\xa1\x00\x3a\x82\x88\xa2\x19\x00\x6e\x83\xa3\xe5\x0b\x04\x4a\
|
||||
\x83\x0b\x01\x10\x0d\xab\xd5\xa5\x83\x9a\x33\xf0\x8a\xd7\x97\x2a\
|
||||
\x3a\x00\xf0\xc0\xcb\x47\xad\x55\xbc\x5b\x7c\x82\xb7\xad\x15\xc8\
|
||||
\xd0\xc3\x85\xcb\x8f\x11\x33\x4d\x10\xda\xd6\x88\xf0\xac\x7c\x1b\
|
||||
\x02\x1a\x04\x67\x90\x82\x13\x02\x79\x06\xc0\x8b\x75\x80\x16\x4b\
|
||||
\xdc\x30\x9c\xec\x7d\x6a\x58\x54\xb3\xd3\xa4\xf1\xf5\x4d\x35\x61\
|
||||
\x5b\xb0\xac\x38\x28\x25\x68\xb5\x02\x44\x81\xaf\x60\x46\x52\x40\
|
||||
\x48\x48\x00\x20\x4d\x00\x58\x07\x7c\x5f\xbc\x05\x00\x2b\x7f\xbc\
|
||||
\xac\xec\x5e\xa8\x4d\xc2\x49\xd8\x30\x0c\x5d\x41\x3c\xa8\x69\x78\
|
||||
\x9f\x9f\xbb\x3d\xfd\x44\xdd\xc9\x6e\x2c\x48\xa3\x1b\x1a\xa4\x9d\
|
||||
\xd4\xd1\x31\xdb\xb1\x69\xa7\xe1\x79\x4d\x50\x4a\x51\xd7\x1a\x70\
|
||||
\xbd\x46\xdb\xbb\x77\x00\x35\x6d\x77\x61\x6e\xd6\x11\x2c\x80\x8c\
|
||||
\x7c\xf0\xa8\x05\xc1\x23\xb7\x67\x80\x0a\xef\x90\x2c\x34\x85\x1a\
|
||||
\x64\xcc\x87\x50\x10\x48\x11\x76\xca\xfe\x06\x81\x37\xee\xc0\xcc\
|
||||
\x8e\x0a\x9c\x00\x00\x00\x00\x49\x45\x4e\x44\xae\x42\x60\x82\
|
||||
\x00\x00\x04\x4d\
|
||||
\x89\
|
||||
\x50\x4e\x47\x0d\x0a\x1a\x0a\x00\x00\x00\x0d\x49\x48\x44\x52\x00\
|
||||
@ -956,7 +1000,7 @@ qt_resource_name = "\
|
||||
|
||||
qt_resource_struct = "\
|
||||
\x00\x00\x00\x00\x00\x02\x00\x00\x00\x02\x00\x00\x00\x01\
|
||||
\x00\x00\x00\x00\x00\x02\x00\x00\x00\x08\x00\x00\x00\x0b\
|
||||
\x00\x00\x00\x00\x00\x02\x00\x00\x00\x09\x00\x00\x00\x0b\
|
||||
\x00\x00\x00\x14\x00\x02\x00\x00\x00\x08\x00\x00\x00\x03\
|
||||
\x00\x00\x00\x54\x00\x00\x00\x00\x00\x01\x00\x00\x02\xda\
|
||||
\x00\x00\x01\x46\x00\x00\x00\x00\x00\x01\x00\x00\x11\x72\
|
||||
@ -967,13 +1011,14 @@ qt_resource_struct = "\
|
||||
\x00\x00\x00\xa0\x00\x00\x00\x00\x00\x01\x00\x00\x08\xd2\
|
||||
\x00\x00\x00\x2a\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\
|
||||
\x00\x00\x01\x6e\x00\x00\x00\x00\x00\x01\x00\x00\x13\xaa\
|
||||
\x00\x00\x02\x3e\x00\x00\x00\x00\x00\x01\x00\x00\x2d\x00\
|
||||
\x00\x00\x02\x3e\x00\x00\x00\x00\x00\x01\x00\x00\x2f\xa4\
|
||||
\x00\x00\x00\x84\x00\x00\x00\x00\x00\x01\x00\x00\x1f\x45\
|
||||
\x00\x00\x01\x84\x00\x00\x00\x00\x00\x01\x00\x00\x17\x15\
|
||||
\x00\x00\x01\xf8\x00\x00\x00\x00\x00\x01\x00\x00\x23\x96\
|
||||
\x00\x00\x01\xd8\x00\x00\x00\x00\x00\x01\x00\x00\x1f\x45\
|
||||
\x00\x00\x01\xf8\x00\x00\x00\x00\x00\x01\x00\x00\x26\x3a\
|
||||
\x00\x00\x01\xd8\x00\x00\x00\x00\x00\x01\x00\x00\x21\xe9\
|
||||
\x00\x00\x01\xb0\x00\x00\x00\x00\x00\x01\x00\x00\x1b\x92\
|
||||
\x00\x00\x02\x26\x00\x00\x00\x00\x00\x01\x00\x00\x28\x08\
|
||||
\x00\x00\x02\x70\x00\x00\x00\x00\x00\x01\x00\x00\x2f\xfc\
|
||||
\x00\x00\x02\x26\x00\x00\x00\x00\x00\x01\x00\x00\x2a\xac\
|
||||
\x00\x00\x02\x70\x00\x00\x00\x00\x00\x01\x00\x00\x32\xa0\
|
||||
"
|
||||
|
||||
def init_resources():
|
||||
@ -981,4 +1026,3 @@ def init_resources():
|
||||
|
||||
def cleanup_resources():
|
||||
QtCore.qUnregisterResourceData(0x01, qt_resource_struct, qt_resource_name, qt_resource_data)
|
||||
|
||||
|
||||
673
colourterm/xmodem.py
Normal file
673
colourterm/xmodem.py
Normal file
@ -0,0 +1,673 @@
|
||||
'''
|
||||
===============================
|
||||
XMODEM file transfer protocol
|
||||
===============================
|
||||
|
||||
.. $Id$
|
||||
|
||||
This is a literal implementation of XMODEM.TXT_, XMODEM1K.TXT_ and
|
||||
XMODMCRC.TXT_, support for YMODEM and ZMODEM is pending. YMODEM should
|
||||
be fairly easy to implement as it is a hack on top of the XMODEM
|
||||
protocol using sequence bytes ``0x00`` for sending file names (and some
|
||||
meta data).
|
||||
|
||||
.. _XMODEM.TXT: doc/XMODEM.TXT
|
||||
.. _XMODEM1K.TXT: doc/XMODEM1K.TXT
|
||||
.. _XMODMCRC.TXT: doc/XMODMCRC.TXT
|
||||
|
||||
Data flow example including error recovery
|
||||
==========================================
|
||||
|
||||
Here is a sample of the data flow, sending a 3-block message.
|
||||
It includes the two most common line hits - a garbaged block,
|
||||
and an ``ACK`` reply getting garbaged. ``CRC`` or ``CSUM`` represents
|
||||
the checksum bytes.
|
||||
|
||||
XMODEM 128 byte blocks
|
||||
----------------------
|
||||
|
||||
::
|
||||
|
||||
SENDER RECEIVER
|
||||
|
||||
<-- NAK
|
||||
SOH 01 FE Data[128] CSUM -->
|
||||
<-- ACK
|
||||
SOH 02 FD Data[128] CSUM -->
|
||||
<-- ACK
|
||||
SOH 03 FC Data[128] CSUM -->
|
||||
<-- ACK
|
||||
SOH 04 FB Data[128] CSUM -->
|
||||
<-- ACK
|
||||
SOH 05 FA Data[100] CPMEOF[28] CSUM -->
|
||||
<-- ACK
|
||||
EOT -->
|
||||
<-- ACK
|
||||
|
||||
XMODEM-1k blocks, CRC mode
|
||||
--------------------------
|
||||
|
||||
::
|
||||
|
||||
SENDER RECEIVER
|
||||
|
||||
<-- C
|
||||
STX 01 FE Data[1024] CRC CRC -->
|
||||
<-- ACK
|
||||
STX 02 FD Data[1024] CRC CRC -->
|
||||
<-- ACK
|
||||
STX 03 FC Data[1000] CPMEOF[24] CRC CRC -->
|
||||
<-- ACK
|
||||
EOT -->
|
||||
<-- ACK
|
||||
|
||||
Mixed 1024 and 128 byte Blocks
|
||||
------------------------------
|
||||
|
||||
::
|
||||
|
||||
SENDER RECEIVER
|
||||
|
||||
<-- C
|
||||
STX 01 FE Data[1024] CRC CRC -->
|
||||
<-- ACK
|
||||
STX 02 FD Data[1024] CRC CRC -->
|
||||
<-- ACK
|
||||
SOH 03 FC Data[128] CRC CRC -->
|
||||
<-- ACK
|
||||
SOH 04 FB Data[100] CPMEOF[28] CRC CRC -->
|
||||
<-- ACK
|
||||
EOT -->
|
||||
<-- ACK
|
||||
|
||||
YMODEM Batch Transmission Session (1 file)
|
||||
------------------------------------------
|
||||
|
||||
::
|
||||
|
||||
SENDER RECEIVER
|
||||
<-- C (command:rb)
|
||||
SOH 00 FF foo.c NUL[123] CRC CRC -->
|
||||
<-- ACK
|
||||
<-- C
|
||||
SOH 01 FE Data[128] CRC CRC -->
|
||||
<-- ACK
|
||||
SOH 02 FC Data[128] CRC CRC -->
|
||||
<-- ACK
|
||||
SOH 03 FB Data[100] CPMEOF[28] CRC CRC -->
|
||||
<-- ACK
|
||||
EOT -->
|
||||
<-- NAK
|
||||
EOT -->
|
||||
<-- ACK
|
||||
<-- C
|
||||
SOH 00 FF NUL[128] CRC CRC -->
|
||||
<-- ACK
|
||||
|
||||
|
||||
'''
|
||||
from __future__ import division, print_function
|
||||
|
||||
__author__ = 'Wijnand Modderman <maze@pyth0n.org>'
|
||||
__copyright__ = ['Copyright (c) 2010 Wijnand Modderman',
|
||||
'Copyright (c) 1981 Chuck Forsberg']
|
||||
__license__ = 'MIT'
|
||||
__version__ = '0.4.0'
|
||||
|
||||
import platform
|
||||
import logging
|
||||
import time
|
||||
import sys
|
||||
from functools import partial
|
||||
|
||||
# Protocol bytes
|
||||
SOH = b'\x01'
|
||||
STX = b'\x02'
|
||||
EOT = b'\x04'
|
||||
ACK = b'\x06'
|
||||
DLE = b'\x10'
|
||||
NAK = b'\x15'
|
||||
CAN = b'\x18'
|
||||
CRC = b'C'
|
||||
|
||||
|
||||
class XMODEM(object):
|
||||
'''
|
||||
XMODEM Protocol handler, expects an object to read from and an object to
|
||||
write to.
|
||||
|
||||
>>> def getc(size, timeout=1):
|
||||
... return data or None
|
||||
...
|
||||
>>> def putc(data, timeout=1):
|
||||
... return size or None
|
||||
...
|
||||
>>> modem = XMODEM(getc, putc)
|
||||
|
||||
|
||||
:param getc: Function to retreive bytes from a stream
|
||||
:type getc: callable
|
||||
:param putc: Function to transmit bytes to a stream
|
||||
:type putc: callable
|
||||
:param mode: XMODEM protocol mode
|
||||
:type mode: string
|
||||
:param pad: Padding character to make the packets match the packet size
|
||||
:type pad: char
|
||||
|
||||
'''
|
||||
|
||||
# crctab calculated by Mark G. Mendel, Network Systems Corporation
|
||||
crctable = [
|
||||
0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
|
||||
0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
|
||||
0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
|
||||
0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
|
||||
0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
|
||||
0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
|
||||
0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
|
||||
0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
|
||||
0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
|
||||
0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
|
||||
0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
|
||||
0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
|
||||
0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
|
||||
0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
|
||||
0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
|
||||
0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
|
||||
0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
|
||||
0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
|
||||
0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
|
||||
0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
|
||||
0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
|
||||
0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
|
||||
0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
|
||||
0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
|
||||
0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
|
||||
0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
|
||||
0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
|
||||
0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
|
||||
0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
|
||||
0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
|
||||
0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
|
||||
0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0,
|
||||
]
|
||||
|
||||
def __init__(self, getc, putc, mode='xmodem', pad=b'\x1a'):
|
||||
self.getc = getc
|
||||
self.putc = putc
|
||||
self.mode = mode
|
||||
self.pad = pad
|
||||
self.log = logging.getLogger('xmodem.XMODEM')
|
||||
|
||||
def abort(self, count=2, timeout=60):
|
||||
'''
|
||||
Send an abort sequence using CAN bytes.
|
||||
'''
|
||||
for _ in range(count):
|
||||
self.putc(CAN, timeout)
|
||||
|
||||
def send(self, stream, retry=16, timeout=60, quiet=False, callback=None):
|
||||
'''
|
||||
Send a stream via the XMODEM protocol.
|
||||
|
||||
>>> stream = file('/etc/issue', 'rb')
|
||||
>>> print(modem.send(stream))
|
||||
True
|
||||
|
||||
Returns ``True`` upon successful transmission or ``False`` in case of
|
||||
failure.
|
||||
|
||||
:param stream: The stream object to send data from.
|
||||
:type stream: stream (file, etc.)
|
||||
:param retry: The maximum number of times to try to resend a failed
|
||||
packet before failing.
|
||||
:type retry: int
|
||||
:param timeout: The number of seconds to wait for a response before
|
||||
timing out.
|
||||
:type timeout: int
|
||||
:param quiet: If True, write transfer information to stderr.
|
||||
:type quiet: bool
|
||||
:param callback: Reference to a callback function that has the
|
||||
following signature. This is useful for
|
||||
getting status updates while a xmodem
|
||||
transfer is underway.
|
||||
Expected callback signature:
|
||||
def callback(total_packets, success_count, error_count)
|
||||
:type callback: callable
|
||||
'''
|
||||
|
||||
# initialize protocol
|
||||
try:
|
||||
packet_size = dict(
|
||||
xmodem = 128,
|
||||
xmodem1k = 1024,
|
||||
)[self.mode]
|
||||
except KeyError:
|
||||
raise ValueError("Invalid mode specified: {self.mode!r}"
|
||||
.format(self=self))
|
||||
|
||||
self.log.debug('Begin start sequence, packet_size=%d', packet_size)
|
||||
error_count = 0
|
||||
crc_mode = 0
|
||||
cancel = 0
|
||||
while True:
|
||||
char = self.getc(1)
|
||||
if char:
|
||||
if char == NAK:
|
||||
self.log.debug('standard checksum requested (NAK).')
|
||||
crc_mode = 0
|
||||
break
|
||||
elif char == CRC:
|
||||
self.log.debug('16-bit CRC requested (CRC).')
|
||||
crc_mode = 1
|
||||
break
|
||||
elif char == CAN:
|
||||
if not quiet:
|
||||
print('received CAN', file=sys.stderr)
|
||||
if cancel:
|
||||
self.log.info('Transmission canceled: received 2xCAN '
|
||||
'at start-sequence')
|
||||
return False
|
||||
else:
|
||||
self.log.debug('cancellation at start sequence.')
|
||||
cancel = 1
|
||||
else:
|
||||
self.log.error('send error: expected NAK, CRC, or CAN; '
|
||||
'got %r', char)
|
||||
|
||||
error_count += 1
|
||||
if error_count >= retry:
|
||||
self.log.info('send error: error_count reached %d, '
|
||||
'aborting.', retry)
|
||||
self.abort(timeout=timeout)
|
||||
return False
|
||||
|
||||
# send data
|
||||
error_count = 0
|
||||
success_count = 0
|
||||
total_packets = 0
|
||||
sequence = 1
|
||||
while True:
|
||||
data = stream.read(packet_size)
|
||||
if not data:
|
||||
# end of stream
|
||||
self.log.debug('send: at EOF')
|
||||
break
|
||||
total_packets += 1
|
||||
|
||||
header = self._make_send_header(packet_size, sequence)
|
||||
data = data.ljust(packet_size, self.pad)
|
||||
checksum = self._make_send_checksum(crc_mode, data)
|
||||
|
||||
# emit packet
|
||||
while True:
|
||||
self.log.debug('send: block %d', sequence)
|
||||
self.putc(header)
|
||||
self.putc(data)
|
||||
self.putc(checksum)
|
||||
char = self.getc(1, timeout)
|
||||
if char == ACK:
|
||||
success_count += 1
|
||||
if callable(callback):
|
||||
callback(total_packets, success_count, error_count)
|
||||
break
|
||||
else:
|
||||
self.log.warn('send error: non-ACK received '
|
||||
'for block %d', sequence)
|
||||
error_count += 1
|
||||
if callable(callback):
|
||||
callback(total_packets, success_count, error_count)
|
||||
if error_count >= retry:
|
||||
# excessive amounts of retransmissions requested,
|
||||
# abort transfer
|
||||
self.log.error('send error: NAK received %d times, '
|
||||
'aborting.', error_count)
|
||||
self.abort(timeout=timeout)
|
||||
return False
|
||||
|
||||
# return to loop and resend
|
||||
continue
|
||||
|
||||
# keep track of sequence
|
||||
sequence = (sequence + 1) % 0x100
|
||||
|
||||
while True:
|
||||
self.log.debug('sending EOT, awaiting ACK')
|
||||
# end of transmission
|
||||
self.putc(EOT)
|
||||
|
||||
# An ACK should be returned
|
||||
char = self.getc(1, timeout)
|
||||
if char == ACK:
|
||||
break
|
||||
else:
|
||||
self.log.error('send error: expected ACK; got %r', char)
|
||||
error_count += 1
|
||||
if error_count >= retry:
|
||||
self.log.warn('EOT was not ACKd, aborting transfer')
|
||||
self.abort(timeout=timeout)
|
||||
return False
|
||||
|
||||
self.log.info('Transmission successful (ACK received).')
|
||||
return True
|
||||
|
||||
def _make_send_header(self, packet_size, sequence):
|
||||
assert packet_size in (128, 1024), packet_size
|
||||
_bytes = []
|
||||
if packet_size == 128:
|
||||
_bytes.append(ord(SOH))
|
||||
elif packet_size == 1024:
|
||||
_bytes.append(ord(STX))
|
||||
_bytes.extend([sequence, 0xff - sequence])
|
||||
return bytearray(_bytes)
|
||||
|
||||
def _make_send_checksum(self, crc_mode, data):
|
||||
_bytes = []
|
||||
if crc_mode:
|
||||
crc = self.calc_crc(data)
|
||||
_bytes.extend([crc >> 8, crc & 0xff])
|
||||
else:
|
||||
crc = self.calc_checksum(data)
|
||||
_bytes.append(crc)
|
||||
return bytearray(_bytes)
|
||||
|
||||
def recv(self, stream, crc_mode=1, retry=16, timeout=60, delay=1, quiet=0):
|
||||
'''
|
||||
Receive a stream via the XMODEM protocol.
|
||||
|
||||
>>> stream = file('/etc/issue', 'wb')
|
||||
>>> print(modem.recv(stream))
|
||||
2342
|
||||
|
||||
Returns the number of bytes received on success or ``None`` in case of
|
||||
failure.
|
||||
'''
|
||||
|
||||
# initiate protocol
|
||||
error_count = 0
|
||||
char = 0
|
||||
cancel = 0
|
||||
while True:
|
||||
# first try CRC mode, if this fails,
|
||||
# fall back to checksum mode
|
||||
if error_count >= retry:
|
||||
self.log.info('error_count reached %d, aborting.', retry)
|
||||
self.abort(timeout=timeout)
|
||||
return None
|
||||
elif crc_mode and error_count < (retry // 2):
|
||||
if not self.putc(CRC):
|
||||
self.log.debug('recv error: putc failed, '
|
||||
'sleeping for %d', delay)
|
||||
time.sleep(delay)
|
||||
error_count += 1
|
||||
else:
|
||||
crc_mode = 0
|
||||
if not self.putc(NAK):
|
||||
self.log.debug('recv error: putc failed, '
|
||||
'sleeping for %d', delay)
|
||||
time.sleep(delay)
|
||||
error_count += 1
|
||||
|
||||
char = self.getc(1, timeout)
|
||||
if char is None:
|
||||
self.log.warn('recv error: getc timeout in start sequence')
|
||||
error_count += 1
|
||||
continue
|
||||
elif char == SOH:
|
||||
self.log.debug('recv: SOH')
|
||||
break
|
||||
elif char == STX:
|
||||
self.log.debug('recv: STX')
|
||||
break
|
||||
elif char == CAN:
|
||||
if cancel:
|
||||
self.log.info('Transmission canceled: received 2xCAN '
|
||||
'at start-sequence')
|
||||
return None
|
||||
else:
|
||||
self.log.debug('cancellation at start sequence.')
|
||||
cancel = 1
|
||||
else:
|
||||
error_count += 1
|
||||
|
||||
# read data
|
||||
error_count = 0
|
||||
income_size = 0
|
||||
packet_size = 128
|
||||
sequence = 1
|
||||
cancel = 0
|
||||
while True:
|
||||
while True:
|
||||
if char == SOH:
|
||||
if packet_size != 128:
|
||||
self.log.debug('recv: SOH, using 128b packet_size')
|
||||
packet_size = 128
|
||||
break
|
||||
elif char == STX:
|
||||
if packet_size != 1024:
|
||||
self.log.debug('recv: SOH, using 1k packet_size')
|
||||
packet_size = 1024
|
||||
break
|
||||
elif char == EOT:
|
||||
# We received an EOT, so send an ACK and return the
|
||||
# received data length.
|
||||
self.putc(ACK)
|
||||
self.log.info("Transmission complete, %d bytes",
|
||||
income_size)
|
||||
return income_size
|
||||
elif char == CAN:
|
||||
# cancel at two consecutive cancels
|
||||
if cancel:
|
||||
self.log.info('Transmission canceled: received 2xCAN '
|
||||
'at block %d', sequence)
|
||||
return None
|
||||
else:
|
||||
self.log.debug('cancellation at block %d', sequence)
|
||||
cancel = 1
|
||||
else:
|
||||
err_msg = ('recv error: expected SOH, EOT; '
|
||||
'got {0!r}'.format(char))
|
||||
if not quiet:
|
||||
print(err_msg, file=sys.stderr)
|
||||
self.log.warn(err_msg)
|
||||
error_count += 1
|
||||
if error_count >= retry:
|
||||
self.log.info('error_count reached %d, aborting.',
|
||||
retry)
|
||||
self.abort()
|
||||
return None
|
||||
|
||||
# read sequence
|
||||
error_count = 0
|
||||
cancel = 0
|
||||
self.log.debug('recv: data block %d', sequence)
|
||||
seq1 = self.getc(1, timeout)
|
||||
if seq1 is None:
|
||||
self.log.warn('getc failed to get first sequence byte')
|
||||
seq2 = None
|
||||
else:
|
||||
seq1 = ord(seq1)
|
||||
seq2 = self.getc(1, timeout)
|
||||
if seq2 is None:
|
||||
self.log.warn('getc failed to get second sequence byte')
|
||||
else:
|
||||
# second byte is the same as first as 1's complement
|
||||
seq2 = 0xff - ord(seq2)
|
||||
|
||||
if not (seq1 == seq2 == sequence):
|
||||
# consume data anyway ... even though we will discard it,
|
||||
# it is not the sequence we expected!
|
||||
self.log.error('expected sequence %d, '
|
||||
'got (seq1=%r, seq2=%r), '
|
||||
'receiving next block, will NAK.',
|
||||
sequence, seq1, seq2)
|
||||
self.getc(packet_size + 1 + crc_mode)
|
||||
else:
|
||||
# sequence is ok, read packet
|
||||
# packet_size + checksum
|
||||
data = self.getc(packet_size + 1 + crc_mode, timeout)
|
||||
valid, data = self._verify_recv_checksum(crc_mode, data)
|
||||
|
||||
# valid data, append chunk
|
||||
if valid:
|
||||
income_size += len(data)
|
||||
stream.write(data)
|
||||
self.putc(ACK)
|
||||
sequence = (sequence + 1) % 0x100
|
||||
# get next start-of-header byte
|
||||
char = self.getc(1, timeout)
|
||||
continue
|
||||
|
||||
# something went wrong, request retransmission
|
||||
self.log.warn('recv error: purge, requesting retransmission (NAK)')
|
||||
while True:
|
||||
# When the receiver wishes to <nak>, it should call a "PURGE"
|
||||
# subroutine, to wait for the line to clear. Recall the sender
|
||||
# tosses any characters in its UART buffer immediately upon
|
||||
# completing sending a block, to ensure no glitches were mis-
|
||||
# interpreted. The most common technique is for "PURGE" to
|
||||
# call the character receive subroutine, specifying a 1-second
|
||||
# timeout, and looping back to PURGE until a timeout occurs.
|
||||
# The <nak> is then sent, ensuring the other end will see it.
|
||||
data = self.getc(1, timeout=1)
|
||||
if data is None:
|
||||
break
|
||||
assert False, data
|
||||
self.putc(NAK)
|
||||
# get next start-of-header byte
|
||||
char = self.getc(1, timeout)
|
||||
continue
|
||||
|
||||
def _verify_recv_checksum(self, crc_mode, data):
|
||||
if crc_mode:
|
||||
_checksum = bytearray(data[-2:])
|
||||
their_sum = (_checksum[0] << 8) + _checksum[1]
|
||||
data = data[:-2]
|
||||
|
||||
our_sum = self.calc_crc(data)
|
||||
valid = bool(their_sum == our_sum)
|
||||
if not valid:
|
||||
self.log.warn('recv error: checksum fail '
|
||||
'(theirs=%04x, ours=%04x), ',
|
||||
their_sum, our_sum)
|
||||
else:
|
||||
_checksum = bytearray([data[-1]])
|
||||
their_sum = _checksum[0]
|
||||
data = data[:-1]
|
||||
|
||||
our_sum = self.calc_checksum(data)
|
||||
valid = their_sum == our_sum
|
||||
if not valid:
|
||||
self.log.warn('recv error: checksum fail '
|
||||
'(theirs=%02x, ours=%02x)',
|
||||
their_sum, our_sum)
|
||||
return valid, data
|
||||
|
||||
def calc_checksum(self, data, checksum=0):
|
||||
'''
|
||||
Calculate the checksum for a given block of data, can also be used to
|
||||
update a checksum.
|
||||
|
||||
>>> csum = modem.calc_checksum('hello')
|
||||
>>> csum = modem.calc_checksum('world', csum)
|
||||
>>> hex(csum)
|
||||
'0x3c'
|
||||
|
||||
'''
|
||||
if platform.python_version_tuple() >= ('3', '0', '0'):
|
||||
return (sum(data) + checksum) % 256
|
||||
else:
|
||||
return (sum(map(ord, data)) + checksum) % 256
|
||||
|
||||
def calc_crc(self, data, crc=0):
|
||||
'''
|
||||
Calculate the Cyclic Redundancy Check for a given block of data, can
|
||||
also be used to update a CRC.
|
||||
|
||||
>>> crc = modem.calc_crc('hello')
|
||||
>>> crc = modem.calc_crc('world', crc)
|
||||
>>> hex(crc)
|
||||
'0xd5e3'
|
||||
|
||||
'''
|
||||
for char in bytearray(data):
|
||||
crctbl_idx = ((crc >> 8) ^ char) & 0xff
|
||||
crc = ((crc << 8) ^ self.crctable[crctbl_idx]) & 0xffff
|
||||
return crc & 0xffff
|
||||
|
||||
|
||||
XMODEM1k = partial(XMODEM, mode='xmodem1k')
|
||||
|
||||
|
||||
def run():
|
||||
import optparse
|
||||
import subprocess
|
||||
|
||||
parser = optparse.OptionParser(
|
||||
usage='%prog [<options>] <send|recv> filename filename')
|
||||
parser.add_option('-m', '--mode', default='xmodem',
|
||||
help='XMODEM mode (xmodem, xmodem1k)')
|
||||
|
||||
options, args = parser.parse_args()
|
||||
if len(args) != 3:
|
||||
parser.error('invalid arguments')
|
||||
return 1
|
||||
|
||||
elif args[0] not in ('send', 'recv'):
|
||||
parser.error('invalid mode')
|
||||
return 1
|
||||
|
||||
def _func(so, si):
|
||||
import select
|
||||
|
||||
print(('si', si))
|
||||
print(('so', so))
|
||||
|
||||
def getc(size, timeout=3):
|
||||
read_ready, _, _ = select.select([so], [], [], timeout)
|
||||
if read_ready:
|
||||
data = so.read(size)
|
||||
else:
|
||||
data = None
|
||||
|
||||
print(('getc(', repr(data), ')'))
|
||||
return data
|
||||
|
||||
def putc(data, timeout=3):
|
||||
_, write_ready, _ = select.select([], [si], [], timeout)
|
||||
if write_ready:
|
||||
si.write(data)
|
||||
si.flush()
|
||||
size = len(data)
|
||||
else:
|
||||
size = None
|
||||
|
||||
print(('putc(', repr(data), repr(size), ')'))
|
||||
return size
|
||||
|
||||
return getc, putc
|
||||
|
||||
def _pipe(*command):
|
||||
pipe = subprocess.Popen(command,
|
||||
stdout=subprocess.PIPE,
|
||||
stdin=subprocess.PIPE)
|
||||
return pipe.stdout, pipe.stdin
|
||||
|
||||
if args[0] == 'recv':
|
||||
getc, putc = _func(*_pipe('sz', '--xmodem', args[2]))
|
||||
stream = open(args[1], 'wb')
|
||||
xmodem = XMODEM(getc, putc, mode=options.mode)
|
||||
status = xmodem.recv(stream, retry=8)
|
||||
assert status, ('Transfer failed, status is', False)
|
||||
stream.close()
|
||||
|
||||
elif args[0] == 'send':
|
||||
getc, putc = _func(*_pipe('rz', '--xmodem', args[2]))
|
||||
stream = open(args[1], 'rb')
|
||||
xmodem = XMODEM(getc, putc, mode=options.mode)
|
||||
sent = xmodem.send(stream, retry=8)
|
||||
assert sent is not None, ('Transfer failed, sent is', sent)
|
||||
stream.close()
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(run())
|
||||
@ -8,6 +8,7 @@
|
||||
<file>application-exit.png</file>
|
||||
<file>network-connect.png</file>
|
||||
<file>network-disconnect.png</file>
|
||||
<file>move-up.png</file>
|
||||
</qresource>
|
||||
<qresource prefix="settings">
|
||||
<file>highlight-save.png</file>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user