cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
Chris Liechti | fbdd8a0 | 2015-08-09 02:37:45 +0200 | [diff] [blame] | 2 | # |
cliechti | a128a70 | 2004-07-21 22:13:31 +0000 | [diff] [blame] | 3 | # Very simple serial terminal |
Chris Liechti | fbdd8a0 | 2015-08-09 02:37:45 +0200 | [diff] [blame] | 4 | # |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 5 | # (C)2002-2015 Chris Liechti <cliechti@gmx.net> |
Chris Liechti | fbdd8a0 | 2015-08-09 02:37:45 +0200 | [diff] [blame] | 6 | # |
| 7 | # SPDX-License-Identifier: BSD-3-Clause |
cliechti | fc9eb38 | 2002-03-05 01:12:29 +0000 | [diff] [blame] | 8 | |
cliechti | a128a70 | 2004-07-21 22:13:31 +0000 | [diff] [blame] | 9 | # Input characters are sent directly (only LF -> CR/LF/CRLF translation is |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 10 | # done), received characters are displayed as is (or escaped through pythons |
cliechti | a128a70 | 2004-07-21 22:13:31 +0000 | [diff] [blame] | 11 | # repr, useful for debug purposes) |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 12 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 13 | import codecs |
Chris Liechti | a1d5c6d | 2015-08-07 14:41:24 +0200 | [diff] [blame] | 14 | import os |
| 15 | import sys |
| 16 | import threading |
cliechti | 21e2c84 | 2012-02-21 16:40:27 +0000 | [diff] [blame] | 17 | try: |
| 18 | from serial.tools.list_ports import comports |
| 19 | except ImportError: |
| 20 | comports = None |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 21 | |
Chris Liechti | a1d5c6d | 2015-08-07 14:41:24 +0200 | [diff] [blame] | 22 | import serial |
| 23 | |
| 24 | |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 25 | try: |
| 26 | raw_input |
| 27 | except NameError: |
| 28 | raw_input = input # in python3 it's "raw" |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 29 | unichr = chr |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 30 | |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 31 | EXITCHARCTER = b'\x1d' # GS/CTRL+] |
| 32 | MENUCHARACTER = b'\x14' # Menu: CTRL+T |
cliechti | a128a70 | 2004-07-21 22:13:31 +0000 | [diff] [blame] | 33 | |
cliechti | 096e196 | 2012-02-20 01:52:38 +0000 | [diff] [blame] | 34 | DEFAULT_PORT = None |
| 35 | DEFAULT_BAUDRATE = 9600 |
| 36 | DEFAULT_RTS = None |
| 37 | DEFAULT_DTR = None |
| 38 | |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 39 | |
| 40 | def key_description(character): |
| 41 | """generate a readable description for a key""" |
| 42 | ascii_code = ord(character) |
| 43 | if ascii_code < 32: |
| 44 | return 'Ctrl+%c' % (ord('@') + ascii_code) |
| 45 | else: |
| 46 | return repr(character) |
| 47 | |
cliechti | 9116553 | 2011-03-18 02:02:52 +0000 | [diff] [blame] | 48 | |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 49 | # help text, starts with blank line! it's a function so that the current values |
| 50 | # for the shortcut keys is used and not the value at program start |
| 51 | def get_help_text(): |
| 52 | return """ |
cliechti | 6963b26 | 2010-01-02 03:01:21 +0000 | [diff] [blame] | 53 | --- pySerial (%(version)s) - miniterm - help |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 54 | --- |
| 55 | --- %(exit)-8s Exit program |
| 56 | --- %(menu)-8s Menu escape key, followed by: |
| 57 | --- Menu keys: |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 58 | --- %(itself)-7s Send the menu character itself to remote |
| 59 | --- %(exchar)-7s Send the exit character itself to remote |
| 60 | --- %(info)-7s Show info |
| 61 | --- %(upload)-7s Upload file (prompt will be shown) |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 62 | --- Toggles: |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 63 | --- %(rts)-7s RTS %(echo)-7s local echo |
| 64 | --- %(dtr)-7s DTR %(break)-7s BREAK |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 65 | --- |
| 66 | --- Port settings (%(menu)s followed by the following): |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 67 | --- p change port |
| 68 | --- 7 8 set data bits |
| 69 | --- n e o s m change parity (None, Even, Odd, Space, Mark) |
| 70 | --- 1 2 3 set stop bits (1, 2, 1.5) |
| 71 | --- b change baud rate |
| 72 | --- x X disable/enable software flow control |
| 73 | --- r R disable/enable hardware flow control |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 74 | """ % { |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 75 | 'version': getattr(serial, 'VERSION', 'unknown version'), |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 76 | 'exit': key_description(EXITCHARCTER), |
| 77 | 'menu': key_description(MENUCHARACTER), |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 78 | 'rts': key_description(b'\x12'), |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 79 | 'dtr': key_description(b'\x04'), |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 80 | 'break': key_description(b'\x02'), |
| 81 | 'echo': key_description(b'\x05'), |
| 82 | 'info': key_description(b'\x09'), |
| 83 | 'upload': key_description(b'\x15'), |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 84 | 'itself': key_description(MENUCHARACTER), |
| 85 | 'exchar': key_description(EXITCHARCTER), |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 86 | } |
| 87 | |
cliechti | 393fa0e | 2011-08-22 00:53:36 +0000 | [diff] [blame] | 88 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 89 | class ConsoleBase(object): |
| 90 | def __init__(self): |
| 91 | if sys.version_info >= (3, 0): |
| 92 | self.byte_output = sys.stdout.buffer |
| 93 | else: |
| 94 | self.byte_output = sys.stdout |
| 95 | self.output = sys.stdout |
cliechti | f467aa8 | 2013-10-13 21:36:49 +0000 | [diff] [blame] | 96 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 97 | def setup(self): |
| 98 | pass # Do nothing for 'nt' |
cliechti | f467aa8 | 2013-10-13 21:36:49 +0000 | [diff] [blame] | 99 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 100 | def cleanup(self): |
| 101 | pass # Do nothing for 'nt' |
| 102 | |
| 103 | def getkey(self): |
| 104 | return None |
| 105 | |
| 106 | def write_bytes(self, s): |
| 107 | self.byte_output.write(s) |
| 108 | self.byte_output.flush() |
| 109 | |
| 110 | def write(self, s): |
| 111 | self.output.write(s) |
| 112 | self.output.flush() |
| 113 | |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 114 | |
cliechti | fc9eb38 | 2002-03-05 01:12:29 +0000 | [diff] [blame] | 115 | if os.name == 'nt': |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 116 | import msvcrt |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 117 | import ctypes |
| 118 | class Console(ConsoleBase): |
cliechti | 3a8bf09 | 2008-09-17 11:26:53 +0000 | [diff] [blame] | 119 | def getkey(self): |
cliechti | 9116553 | 2011-03-18 02:02:52 +0000 | [diff] [blame] | 120 | while True: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 121 | z = msvcrt.getwch() |
| 122 | if z == '\r': |
| 123 | return '\n' |
| 124 | elif z in '\x00\x0e': # functions keys, ignore |
| 125 | msvcrt.getwch() |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 126 | else: |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 127 | return z |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 128 | |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 129 | def write(self, s): |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 130 | # works, kind of.. can't print unicode |
| 131 | self.byte_output.write(s.encode(sys.stdout.encoding, 'replace')) |
| 132 | #~ sys.stdout.write(s) # fails with encoding errors |
| 133 | #~ for byte in data: # fails for python3 as it returns ints instead of b'' |
| 134 | #~ for x in range(len(s)): |
| 135 | #~ byte = s[x:x+1] |
| 136 | #~ msvcrt.putwch(byte) # blocks?!? non-overlapped win io? |
| 137 | |
| 138 | def write_bytes(self, data): |
| 139 | #~ for byte in data: # fails for python3 as it returns ints instead of b'' |
| 140 | for x in range(len(data)): |
| 141 | byte = data[x:x+1] |
| 142 | msvcrt.putch(byte) |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 143 | |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 144 | elif os.name == 'posix': |
Chris Liechti | a1d5c6d | 2015-08-07 14:41:24 +0200 | [diff] [blame] | 145 | import atexit |
| 146 | import termios |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 147 | class Console(ConsoleBase): |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 148 | def __init__(self): |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 149 | super(Console, self).__init__() |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 150 | self.fd = sys.stdin.fileno() |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 151 | self.old = None |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 152 | atexit.register(self.cleanup) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 153 | if sys.version_info < (3, 0): |
| 154 | sys.stdin = codecs.getreader(sys.stdin.encoding)(sys.stdin) |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 155 | |
| 156 | def setup(self): |
| 157 | self.old = termios.tcgetattr(self.fd) |
| 158 | new = termios.tcgetattr(self.fd) |
| 159 | new[3] = new[3] & ~termios.ICANON & ~termios.ECHO & ~termios.ISIG |
| 160 | new[6][termios.VMIN] = 1 |
| 161 | new[6][termios.VTIME] = 0 |
| 162 | termios.tcsetattr(self.fd, termios.TCSANOW, new) |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 163 | |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 164 | def getkey(self): |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 165 | return sys.stdin.read(1) |
| 166 | #~ c = os.read(self.fd, 1) |
| 167 | #~ return c |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 168 | |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 169 | def cleanup(self): |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 170 | if self.old is not None: |
| 171 | termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.old) |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 172 | |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 173 | else: |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 174 | raise NotImplementedError("Sorry no implementation for your platform (%s) available." % sys.platform) |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 175 | |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 176 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 177 | # XXX how to handle multi byte sequences like CRLF? |
| 178 | # codecs.IncrementalEncoder would be a good choice |
| 179 | |
| 180 | class Transform(object): |
| 181 | def input(self, text): |
| 182 | """text received from serial port""" |
| 183 | return text |
| 184 | |
| 185 | def output(self, text): |
| 186 | """text to be sent to serial port""" |
| 187 | return text |
| 188 | |
| 189 | def echo(self, text): |
| 190 | """text to be sent but displayed on console""" |
| 191 | return text |
| 192 | |
| 193 | class CRLF(Transform): |
| 194 | """ENTER sends CR+LF""" |
| 195 | def input(self, text): |
| 196 | return text.replace('\r\n', '\n') |
| 197 | |
| 198 | def output(self, text): |
| 199 | return text.replace('\n', '\r\n') |
| 200 | |
| 201 | class CR(Transform): |
| 202 | """ENTER sends CR""" |
| 203 | def input(self, text): |
| 204 | return text.replace('\r', '\n') |
| 205 | |
| 206 | def output(self, text): |
| 207 | return text.replace('\n', '\r') |
| 208 | |
| 209 | class LF(Transform): |
| 210 | """ENTER sends LF""" |
| 211 | |
| 212 | |
| 213 | class NoTerminal(Transform): |
| 214 | """remove typical terminal control codes from input""" |
| 215 | def input(self, text): |
| 216 | return ''.join(t if t >= ' ' or t in '\r\n' else unichr(0x2400 + ord(t)) for t in text) |
| 217 | |
| 218 | echo = input |
| 219 | |
| 220 | |
| 221 | class NoControls(Transform): |
| 222 | """Remove all control codes, incl. CR+LF""" |
| 223 | def input(self, text): |
| 224 | return ''.join(t if t >= ' ' else unichr(0x2400 + ord(t)) for t in text) |
| 225 | |
| 226 | echo = input |
| 227 | |
| 228 | |
| 229 | class HexDump(Transform): |
| 230 | """Complete hex dump""" |
| 231 | def input(self, text): |
| 232 | return ''.join('{:02x} '.format(ord(t)) for t in text) |
| 233 | |
| 234 | echo = input |
| 235 | |
| 236 | |
| 237 | class Printable(Transform): |
| 238 | """Show decimal code for all non-ASCII characters and control codes""" |
| 239 | def input(self, text): |
| 240 | r = [] |
| 241 | for t in text: |
| 242 | if ' ' <= t < '\x7f' or t in '\r\n': |
| 243 | r.append(t) |
| 244 | else: |
| 245 | r.extend(unichr(0x2080 + ord(d) - 48) for d in '{:d}'.format(ord(t))) |
| 246 | r.append(' ') |
| 247 | return ''.join(r) |
| 248 | |
| 249 | echo = input |
| 250 | |
| 251 | |
| 252 | |
| 253 | class Colorize(Transform): |
| 254 | """Apply different colors for input and echo""" |
| 255 | def __init__(self): |
| 256 | # XXX make it configurable, use colorama? |
| 257 | self.input_color = '\x1b[37m' |
| 258 | self.echo_color = '\x1b[31m' |
| 259 | |
| 260 | def input(self, text): |
| 261 | return self.input_color + text |
| 262 | |
| 263 | def echo(self, text): |
| 264 | return self.echo_color + text |
| 265 | |
| 266 | class DebugIO(Transform): |
| 267 | """Apply different colors for input and echo""" |
| 268 | def input(self, text): |
| 269 | sys.stderr.write('in: %r\n' % text) |
| 270 | return text |
| 271 | |
| 272 | def echo(self, text): |
| 273 | sys.stderr.write('out: %r\n' % text) |
| 274 | return text |
| 275 | |
| 276 | # other ideas: |
| 277 | # - add date/time for each newline |
| 278 | # - insert newline after: a) timeout b) packet end character |
| 279 | |
| 280 | TRANSFORMATIONS = { |
| 281 | 'crlf': CRLF, |
| 282 | 'cr': CR, |
| 283 | 'lf': LF, |
| 284 | 'default': NoTerminal, |
| 285 | 'nocontrol': NoControls, |
| 286 | 'printable': Printable, |
| 287 | 'hex': HexDump, |
| 288 | 'colorize': Colorize, |
| 289 | 'debug': DebugIO, |
| 290 | } |
| 291 | |
| 292 | |
cliechti | 1351dde | 2012-04-12 16:47:47 +0000 | [diff] [blame] | 293 | def dump_port_list(): |
| 294 | if comports: |
| 295 | sys.stderr.write('\n--- Available ports:\n') |
| 296 | for port, desc, hwid in sorted(comports()): |
| 297 | #~ sys.stderr.write('--- %-20s %s [%s]\n' % (port, desc, hwid)) |
| 298 | sys.stderr.write('--- %-20s %s\n' % (port, desc)) |
| 299 | |
| 300 | |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 301 | class Miniterm(object): |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 302 | def __init__(self, port, baudrate, parity, rtscts, xonxoff, echo=False, transformations=()): |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 303 | self.console = Console() |
Chris Liechti | a1d5c6d | 2015-08-07 14:41:24 +0200 | [diff] [blame] | 304 | self.serial = serial.serial_for_url(port, baudrate, parity=parity, rtscts=rtscts, xonxoff=xonxoff, timeout=1) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 305 | self.echo = echo |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 306 | self.dtr_state = True |
| 307 | self.rts_state = True |
| 308 | self.break_state = False |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 309 | self.raw = False |
| 310 | self.input_encoding = 'latin1' |
| 311 | self.input_error_handling = 'replace' |
| 312 | self.output_encoding = 'latin1' |
| 313 | self.output_error_handling = 'ignore' |
| 314 | self.transformations = [TRANSFORMATIONS[t]() for t in transformations] |
| 315 | self.transformation_names = transformations |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 316 | |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 317 | def _start_reader(self): |
| 318 | """Start reader thread""" |
| 319 | self._reader_alive = True |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 320 | # start serial->console thread |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 321 | self.receiver_thread = threading.Thread(target=self.reader) |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 322 | self.receiver_thread.setDaemon(True) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 323 | self.receiver_thread.start() |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 324 | |
| 325 | def _stop_reader(self): |
| 326 | """Stop reader thread only, wait for clean exit of thread""" |
| 327 | self._reader_alive = False |
| 328 | self.receiver_thread.join() |
| 329 | |
| 330 | |
| 331 | def start(self): |
| 332 | self.alive = True |
| 333 | self._start_reader() |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 334 | # enter console->serial loop |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 335 | self.transmitter_thread = threading.Thread(target=self.writer) |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 336 | self.transmitter_thread.setDaemon(True) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 337 | self.transmitter_thread.start() |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 338 | self.console.setup() |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 339 | |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 340 | def stop(self): |
| 341 | self.alive = False |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 342 | |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 343 | def join(self, transmit_only=False): |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 344 | self.transmitter_thread.join() |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 345 | if not transmit_only: |
| 346 | self.receiver_thread.join() |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 347 | |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 348 | def dump_port_settings(self): |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 349 | sys.stderr.write("\n--- Settings: %s %s,%s,%s,%s\n" % ( |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 350 | self.serial.portstr, |
| 351 | self.serial.baudrate, |
| 352 | self.serial.bytesize, |
| 353 | self.serial.parity, |
| 354 | self.serial.stopbits)) |
| 355 | sys.stderr.write('--- RTS: %-8s DTR: %-8s BREAK: %-8s\n' % ( |
| 356 | (self.rts_state and 'active' or 'inactive'), |
| 357 | (self.dtr_state and 'active' or 'inactive'), |
| 358 | (self.break_state and 'active' or 'inactive'))) |
cliechti | 1011457 | 2009-08-05 23:40:50 +0000 | [diff] [blame] | 359 | try: |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 360 | sys.stderr.write('--- CTS: %-8s DSR: %-8s RI: %-8s CD: %-8s\n' % ( |
| 361 | (self.serial.getCTS() and 'active' or 'inactive'), |
| 362 | (self.serial.getDSR() and 'active' or 'inactive'), |
| 363 | (self.serial.getRI() and 'active' or 'inactive'), |
| 364 | (self.serial.getCD() and 'active' or 'inactive'))) |
cliechti | 1011457 | 2009-08-05 23:40:50 +0000 | [diff] [blame] | 365 | except serial.SerialException: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 366 | # on RFC 2217 ports, it can happen to no modem state notification was |
cliechti | 1011457 | 2009-08-05 23:40:50 +0000 | [diff] [blame] | 367 | # yet received. ignore this error. |
| 368 | pass |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 369 | sys.stderr.write('--- software flow control: %s\n' % (self.serial.xonxoff and 'active' or 'inactive')) |
| 370 | sys.stderr.write('--- hardware flow control: %s\n' % (self.serial.rtscts and 'active' or 'inactive')) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 371 | #~ sys.stderr.write('--- data escaping: %s linefeed: %s\n' % ( |
| 372 | #~ REPR_MODES[self.repr_mode], |
| 373 | #~ LF_MODES[self.convert_outgoing])) |
| 374 | sys.stderr.write('--- serial input encoding: %s\n' % (self.input_encoding,)) |
| 375 | sys.stderr.write('--- serial output encoding: %s\n' % (self.output_encoding,)) |
| 376 | sys.stderr.write('--- transformations: %s\n' % ' '.join(self.transformation_names)) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 377 | |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 378 | def reader(self): |
| 379 | """loop and copy serial->console""" |
cliechti | 6963b26 | 2010-01-02 03:01:21 +0000 | [diff] [blame] | 380 | try: |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 381 | while self.alive and self._reader_alive: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 382 | data = self.serial.read(1) + self.serial.read(self.serial.inWaiting()) |
| 383 | if data: |
| 384 | if self.raw: |
| 385 | self.console.write_bytes(data) |
cliechti | 6963b26 | 2010-01-02 03:01:21 +0000 | [diff] [blame] | 386 | else: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 387 | text = codecs.decode( |
| 388 | data, |
| 389 | self.input_encoding, |
| 390 | self.input_error_handling) |
| 391 | for transformation in self.transformations: |
| 392 | text = transformation.input(text) |
| 393 | self.console.write(text) |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 394 | except serial.SerialException as e: |
cliechti | 6963b26 | 2010-01-02 03:01:21 +0000 | [diff] [blame] | 395 | self.alive = False |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 396 | # XXX would be nice if the writer could be interrupted at this |
| 397 | # point... to exit completely |
cliechti | 6963b26 | 2010-01-02 03:01:21 +0000 | [diff] [blame] | 398 | raise |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 399 | |
cliechti | 576de25 | 2002-02-28 23:54:44 +0000 | [diff] [blame] | 400 | |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 401 | def writer(self): |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 402 | """\ |
| 403 | Loop and copy console->serial until EXITCHARCTER character is |
| 404 | found. When MENUCHARACTER is found, interpret the next key |
| 405 | locally. |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 406 | """ |
| 407 | menu_active = False |
| 408 | try: |
| 409 | while self.alive: |
| 410 | try: |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 411 | c = self.console.getkey() |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 412 | except KeyboardInterrupt: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 413 | c = '\x03' |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 414 | if menu_active: |
| 415 | if c == MENUCHARACTER or c == EXITCHARCTER: # Menu character again/exit char -> send itself |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 416 | b = codecs.encode( |
| 417 | c, |
| 418 | self.output_encoding, |
| 419 | self.output_error_handling) |
| 420 | self.serial.write(b) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 421 | if self.echo: |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 422 | self.console.write(c) |
| 423 | elif c == b'\x15': # CTRL+U -> upload file |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 424 | sys.stderr.write('\n--- File to upload: ') |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 425 | sys.stderr.flush() |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 426 | self.console.cleanup() |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 427 | filename = sys.stdin.readline().rstrip('\r\n') |
| 428 | if filename: |
| 429 | try: |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 430 | with open(filename, 'rb') as f: |
| 431 | sys.stderr.write('--- Sending file %s ---\n' % filename) |
| 432 | while True: |
| 433 | block = f.read(1024) |
| 434 | if not block: |
| 435 | break |
| 436 | self.serial.write(block) |
| 437 | # Wait for output buffer to drain. |
| 438 | self.serial.flush() |
| 439 | sys.stderr.write('.') # Progress indicator. |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 440 | sys.stderr.write('\n--- File %s sent ---\n' % filename) |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 441 | except IOError as e: |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 442 | sys.stderr.write('--- ERROR opening file %s: %s ---\n' % (filename, e)) |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 443 | self.console.setup() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 444 | elif c in '\x08hH?': # CTRL+H, h, H, ? -> Show help |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 445 | sys.stderr.write(get_help_text()) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 446 | elif c == '\x12': # CTRL+R -> Toggle RTS |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 447 | self.rts_state = not self.rts_state |
| 448 | self.serial.setRTS(self.rts_state) |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 449 | sys.stderr.write('--- RTS %s ---\n' % (self.rts_state and 'active' or 'inactive')) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 450 | elif c == '\x04': # CTRL+D -> Toggle DTR |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 451 | self.dtr_state = not self.dtr_state |
| 452 | self.serial.setDTR(self.dtr_state) |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 453 | sys.stderr.write('--- DTR %s ---\n' % (self.dtr_state and 'active' or 'inactive')) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 454 | elif c == '\x02': # CTRL+B -> toggle BREAK condition |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 455 | self.break_state = not self.break_state |
| 456 | self.serial.setBreak(self.break_state) |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 457 | sys.stderr.write('--- BREAK %s ---\n' % (self.break_state and 'active' or 'inactive')) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 458 | elif c == '\x05': # CTRL+E -> toggle local echo |
cliechti | e0af397 | 2009-07-08 11:03:47 +0000 | [diff] [blame] | 459 | self.echo = not self.echo |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 460 | sys.stderr.write('--- local echo %s ---\n' % (self.echo and 'active' or 'inactive')) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 461 | elif c == '\x09': # CTRL+I -> info |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 462 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 463 | #~ elif c == '\x01': # CTRL+A -> cycle escape mode |
| 464 | #~ elif c == '\x0c': # CTRL+L -> cycle linefeed mode |
| 465 | elif c in 'pP': # P -> change port |
cliechti | 1351dde | 2012-04-12 16:47:47 +0000 | [diff] [blame] | 466 | dump_port_list() |
cliechti | 21e2c84 | 2012-02-21 16:40:27 +0000 | [diff] [blame] | 467 | sys.stderr.write('--- Enter port name: ') |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 468 | sys.stderr.flush() |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 469 | self.console.cleanup() |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 470 | try: |
| 471 | port = sys.stdin.readline().strip() |
| 472 | except KeyboardInterrupt: |
| 473 | port = None |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 474 | self.console.setup() |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 475 | if port and port != self.serial.port: |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 476 | # reader thread needs to be shut down |
| 477 | self._stop_reader() |
| 478 | # save settings |
| 479 | settings = self.serial.getSettingsDict() |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 480 | try: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 481 | new_serial = serial.serial_for_url(port, do_not_open=True) |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 482 | # restore settings and open |
| 483 | new_serial.applySettingsDict(settings) |
| 484 | new_serial.open() |
| 485 | new_serial.setRTS(self.rts_state) |
| 486 | new_serial.setDTR(self.dtr_state) |
| 487 | new_serial.setBreak(self.break_state) |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 488 | except Exception as e: |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 489 | sys.stderr.write('--- ERROR opening new port: %s ---\n' % (e,)) |
| 490 | new_serial.close() |
| 491 | else: |
| 492 | self.serial.close() |
| 493 | self.serial = new_serial |
| 494 | sys.stderr.write('--- Port changed to: %s ---\n' % (self.serial.port,)) |
cliechti | 9116553 | 2011-03-18 02:02:52 +0000 | [diff] [blame] | 495 | # and restart the reader thread |
cliechti | 8c2ea84 | 2011-03-18 01:51:46 +0000 | [diff] [blame] | 496 | self._start_reader() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 497 | elif c in 'bB': # B -> change baudrate |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 498 | sys.stderr.write('\n--- Baudrate: ') |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 499 | sys.stderr.flush() |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 500 | self.console.cleanup() |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 501 | backup = self.serial.baudrate |
| 502 | try: |
| 503 | self.serial.baudrate = int(sys.stdin.readline().strip()) |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 504 | except ValueError as e: |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 505 | sys.stderr.write('--- ERROR setting baudrate: %s ---\n' % (e,)) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 506 | self.serial.baudrate = backup |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 507 | else: |
| 508 | self.dump_port_settings() |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 509 | self.console.setup() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 510 | elif c == '8': # 8 -> change to 8 bits |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 511 | self.serial.bytesize = serial.EIGHTBITS |
| 512 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 513 | elif c == '7': # 7 -> change to 8 bits |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 514 | self.serial.bytesize = serial.SEVENBITS |
| 515 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 516 | elif c in 'eE': # E -> change to even parity |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 517 | self.serial.parity = serial.PARITY_EVEN |
| 518 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 519 | elif c in 'oO': # O -> change to odd parity |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 520 | self.serial.parity = serial.PARITY_ODD |
| 521 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 522 | elif c in 'mM': # M -> change to mark parity |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 523 | self.serial.parity = serial.PARITY_MARK |
| 524 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 525 | elif c in 'sS': # S -> change to space parity |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 526 | self.serial.parity = serial.PARITY_SPACE |
| 527 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 528 | elif c in 'nN': # N -> change to no parity |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 529 | self.serial.parity = serial.PARITY_NONE |
| 530 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 531 | elif c == '1': # 1 -> change to 1 stop bits |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 532 | self.serial.stopbits = serial.STOPBITS_ONE |
| 533 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 534 | elif c == '2': # 2 -> change to 2 stop bits |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 535 | self.serial.stopbits = serial.STOPBITS_TWO |
| 536 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 537 | elif c == '3': # 3 -> change to 1.5 stop bits |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 538 | self.serial.stopbits = serial.STOPBITS_ONE_POINT_FIVE |
| 539 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 540 | elif c in 'xX': # X -> change software flow control |
| 541 | self.serial.xonxoff = (c == 'X') |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 542 | self.dump_port_settings() |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 543 | elif c in 'rR': # R -> change hardware flow control |
| 544 | self.serial.rtscts = (c == 'R') |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 545 | self.dump_port_settings() |
| 546 | else: |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 547 | sys.stderr.write('--- unknown menu character %s --\n' % key_description(c)) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 548 | menu_active = False |
| 549 | elif c == MENUCHARACTER: # next char will be for menu |
| 550 | menu_active = True |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 551 | elif c == EXITCHARCTER: |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 552 | self.stop() |
| 553 | break # exit app |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 554 | else: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 555 | #~ if self.raw: |
| 556 | text = c |
| 557 | echo_text = text |
| 558 | for transformation in self.transformations: |
| 559 | text = transformation.output(text) |
| 560 | echo_text = transformation.echo(echo_text) |
| 561 | b = codecs.encode( |
| 562 | text, |
| 563 | self.output_encoding, |
| 564 | self.output_error_handling) |
| 565 | self.serial.write(b) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 566 | if self.echo: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 567 | self.console.write(echo_text) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 568 | except: |
| 569 | self.alive = False |
| 570 | raise |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 571 | |
| 572 | def main(): |
| 573 | import optparse |
| 574 | |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 575 | parser = optparse.OptionParser( |
| 576 | usage = "%prog [options] [port [baudrate]]", |
| 577 | description = "Miniterm - A simple terminal program for the serial port." |
| 578 | ) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 579 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 580 | group = optparse.OptionGroup(parser, "Port settings") |
| 581 | |
| 582 | group.add_option("-p", "--port", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 583 | dest = "port", |
cliechti | 9116553 | 2011-03-18 02:02:52 +0000 | [diff] [blame] | 584 | help = "port, a number or a device name. (deprecated option, use parameter instead)", |
cliechti | 096e196 | 2012-02-20 01:52:38 +0000 | [diff] [blame] | 585 | default = DEFAULT_PORT |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 586 | ) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 587 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 588 | group.add_option("-b", "--baud", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 589 | dest = "baudrate", |
| 590 | action = "store", |
| 591 | type = 'int', |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 592 | help = "set baud rate, default %default", |
cliechti | 096e196 | 2012-02-20 01:52:38 +0000 | [diff] [blame] | 593 | default = DEFAULT_BAUDRATE |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 594 | ) |
| 595 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 596 | group.add_option("--parity", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 597 | dest = "parity", |
| 598 | action = "store", |
cliechti | e0af397 | 2009-07-08 11:03:47 +0000 | [diff] [blame] | 599 | help = "set parity, one of [N, E, O, S, M], default=N", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 600 | default = 'N' |
| 601 | ) |
| 602 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 603 | group.add_option("--rtscts", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 604 | dest = "rtscts", |
| 605 | action = "store_true", |
| 606 | help = "enable RTS/CTS flow control (default off)", |
| 607 | default = False |
| 608 | ) |
| 609 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 610 | group.add_option("--xonxoff", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 611 | dest = "xonxoff", |
| 612 | action = "store_true", |
| 613 | help = "enable software flow control (default off)", |
| 614 | default = False |
| 615 | ) |
| 616 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 617 | group.add_option("--rts", |
| 618 | dest = "rts_state", |
| 619 | action = "store", |
| 620 | type = 'int', |
| 621 | help = "set initial RTS line state (possible values: 0, 1)", |
| 622 | default = DEFAULT_RTS |
| 623 | ) |
| 624 | |
| 625 | group.add_option("--dtr", |
| 626 | dest = "dtr_state", |
| 627 | action = "store", |
| 628 | type = 'int', |
| 629 | help = "set initial DTR line state (possible values: 0, 1)", |
| 630 | default = DEFAULT_DTR |
| 631 | ) |
| 632 | |
| 633 | parser.add_option_group(group) |
| 634 | |
| 635 | group = optparse.OptionGroup(parser, "Data handling") |
| 636 | |
| 637 | group.add_option("-e", "--echo", |
| 638 | dest = "echo", |
| 639 | action = "store_true", |
| 640 | help = "enable local echo (default off)", |
| 641 | default = False |
| 642 | ) |
| 643 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 644 | group.add_option("-t", "--transformation", |
| 645 | dest = "transformations", |
| 646 | action = "append", |
| 647 | help = "Add text transformation", |
| 648 | default = [] |
| 649 | ) |
| 650 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 651 | group.add_option("--cr", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 652 | dest = "cr", |
| 653 | action = "store_true", |
| 654 | help = "do not send CR+LF, send CR only", |
| 655 | default = False |
| 656 | ) |
| 657 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 658 | group.add_option("--lf", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 659 | dest = "lf", |
| 660 | action = "store_true", |
| 661 | help = "do not send CR+LF, send LF only", |
| 662 | default = False |
| 663 | ) |
| 664 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 665 | group.add_option("--raw", |
| 666 | dest = "raw", |
| 667 | action = "store_true", |
| 668 | help = "Do no apply any encodings/transformations", |
| 669 | default = False |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 670 | ) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 671 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 672 | parser.add_option_group(group) |
cliechti | b7d746d | 2006-03-28 22:44:30 +0000 | [diff] [blame] | 673 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 674 | group = optparse.OptionGroup(parser, "Hotkeys") |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 675 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 676 | group.add_option("--exit-char", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 677 | dest = "exit_char", |
| 678 | action = "store", |
| 679 | type = 'int', |
| 680 | help = "ASCII code of special character that is used to exit the application", |
| 681 | default = 0x1d |
| 682 | ) |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 683 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 684 | group.add_option("--menu-char", |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 685 | dest = "menu_char", |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 686 | action = "store", |
| 687 | type = 'int', |
cliechti | dfec0c8 | 2009-07-21 01:35:41 +0000 | [diff] [blame] | 688 | help = "ASCII code of special character that is used to control miniterm (menu)", |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 689 | default = 0x14 |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 690 | ) |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 691 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 692 | parser.add_option_group(group) |
| 693 | |
| 694 | group = optparse.OptionGroup(parser, "Diagnostics") |
| 695 | |
| 696 | group.add_option("-q", "--quiet", |
| 697 | dest = "quiet", |
| 698 | action = "store_true", |
| 699 | help = "suppress non-error messages", |
| 700 | default = False |
| 701 | ) |
| 702 | |
Chris Liechti | 9109091 | 2015-08-05 02:36:14 +0200 | [diff] [blame] | 703 | group.add_option("", "--develop", |
| 704 | dest = "develop", |
| 705 | action = "store_true", |
| 706 | help = "show Python traceback on error", |
| 707 | default = False |
| 708 | ) |
| 709 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 710 | parser.add_option_group(group) |
| 711 | |
| 712 | |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 713 | (options, args) = parser.parse_args() |
| 714 | |
cliechti | e0af397 | 2009-07-08 11:03:47 +0000 | [diff] [blame] | 715 | options.parity = options.parity.upper() |
| 716 | if options.parity not in 'NEOSM': |
| 717 | parser.error("invalid parity") |
| 718 | |
cliechti | 9cf2622 | 2006-03-24 20:09:21 +0000 | [diff] [blame] | 719 | if options.cr and options.lf: |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 720 | parser.error("only one of --cr or --lf can be specified") |
| 721 | |
cliechti | c1ca077 | 2009-08-05 12:34:04 +0000 | [diff] [blame] | 722 | if options.menu_char == options.exit_char: |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 723 | parser.error('--exit-char can not be the same as --menu-char') |
| 724 | |
| 725 | global EXITCHARCTER, MENUCHARACTER |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 726 | EXITCHARCTER = chr(options.exit_char) |
| 727 | MENUCHARACTER = chr(options.menu_char) |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 728 | |
cliechti | 9743e22 | 2006-04-04 21:48:56 +0000 | [diff] [blame] | 729 | port = options.port |
| 730 | baudrate = options.baudrate |
cliechti | 9cf2622 | 2006-03-24 20:09:21 +0000 | [diff] [blame] | 731 | if args: |
cliechti | 9743e22 | 2006-04-04 21:48:56 +0000 | [diff] [blame] | 732 | if options.port is not None: |
| 733 | parser.error("no arguments are allowed, options only when --port is given") |
| 734 | port = args.pop(0) |
| 735 | if args: |
| 736 | try: |
| 737 | baudrate = int(args[0]) |
| 738 | except ValueError: |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 739 | parser.error("baud rate must be a number, not %r" % args[0]) |
cliechti | 9743e22 | 2006-04-04 21:48:56 +0000 | [diff] [blame] | 740 | args.pop(0) |
| 741 | if args: |
| 742 | parser.error("too many arguments") |
| 743 | else: |
cliechti | 7d44856 | 2014-08-03 21:57:45 +0000 | [diff] [blame] | 744 | # no port given on command line -> ask user now |
cliechti | 1351dde | 2012-04-12 16:47:47 +0000 | [diff] [blame] | 745 | if port is None: |
| 746 | dump_port_list() |
| 747 | port = raw_input('Enter port name:') |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 748 | |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 749 | if options.transformations: |
| 750 | if 'help' in options.transformations: |
| 751 | sys.stderr.write('Available Transformations:\n') |
| 752 | sys.stderr.write('\n'.join('{:<20} = {.__doc__}'.format(k,v) for k,v in sorted(TRANSFORMATIONS.items()))) |
| 753 | sys.stderr.write('\n') |
| 754 | sys.exit(1) |
| 755 | transformations = options.transformations |
| 756 | else: |
| 757 | transformations = ['default'] |
| 758 | |
cliechti | 9cf2622 | 2006-03-24 20:09:21 +0000 | [diff] [blame] | 759 | if options.cr: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 760 | transformations.append('cr') |
cliechti | 9cf2622 | 2006-03-24 20:09:21 +0000 | [diff] [blame] | 761 | elif options.lf: |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 762 | transformations.append('lf') |
| 763 | else: |
| 764 | transformations.append('crlf') |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 765 | |
| 766 | try: |
| 767 | miniterm = Miniterm( |
cliechti | 9743e22 | 2006-04-04 21:48:56 +0000 | [diff] [blame] | 768 | port, |
| 769 | baudrate, |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 770 | options.parity, |
| 771 | rtscts=options.rtscts, |
| 772 | xonxoff=options.xonxoff, |
| 773 | echo=options.echo, |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 774 | transformations=transformations, |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 775 | ) |
Chris Liechti | c7a5d4c | 2015-08-11 23:32:20 +0200 | [diff] [blame^] | 776 | miniterm.raw = options.raw |
Chris Liechti | 68340d7 | 2015-08-03 14:15:48 +0200 | [diff] [blame] | 777 | except serial.SerialException as e: |
cliechti | eb4a14f | 2009-08-03 23:48:35 +0000 | [diff] [blame] | 778 | sys.stderr.write("could not open port %r: %s\n" % (port, e)) |
Chris Liechti | 9109091 | 2015-08-05 02:36:14 +0200 | [diff] [blame] | 779 | if options.develop: |
| 780 | raise |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 781 | sys.exit(1) |
| 782 | |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 783 | if not options.quiet: |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 784 | sys.stderr.write('--- Miniterm on %s: %d,%s,%s,%s ---\n' % ( |
cliechti | 9743e22 | 2006-04-04 21:48:56 +0000 | [diff] [blame] | 785 | miniterm.serial.portstr, |
| 786 | miniterm.serial.baudrate, |
| 787 | miniterm.serial.bytesize, |
| 788 | miniterm.serial.parity, |
| 789 | miniterm.serial.stopbits, |
| 790 | )) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 791 | sys.stderr.write('--- Quit: %s | Menu: %s | Help: %s followed by %s ---\n' % ( |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 792 | key_description(EXITCHARCTER), |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 793 | key_description(MENUCHARACTER), |
| 794 | key_description(MENUCHARACTER), |
Chris Liechti | 89eb247 | 2015-08-08 17:06:25 +0200 | [diff] [blame] | 795 | key_description(b'\x08'), |
cliechti | 9c592b3 | 2008-06-16 22:00:14 +0000 | [diff] [blame] | 796 | )) |
cliechti | 6fa76fb | 2009-07-08 23:53:39 +0000 | [diff] [blame] | 797 | |
cliechti | b7d746d | 2006-03-28 22:44:30 +0000 | [diff] [blame] | 798 | if options.dtr_state is not None: |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 799 | if not options.quiet: |
| 800 | sys.stderr.write('--- forcing DTR %s\n' % (options.dtr_state and 'active' or 'inactive')) |
cliechti | b7d746d | 2006-03-28 22:44:30 +0000 | [diff] [blame] | 801 | miniterm.serial.setDTR(options.dtr_state) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 802 | miniterm.dtr_state = options.dtr_state |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 803 | if options.rts_state is not None: |
| 804 | if not options.quiet: |
| 805 | sys.stderr.write('--- forcing RTS %s\n' % (options.rts_state and 'active' or 'inactive')) |
| 806 | miniterm.serial.setRTS(options.rts_state) |
cliechti | 6c8eb2f | 2009-07-08 02:10:46 +0000 | [diff] [blame] | 807 | miniterm.rts_state = options.rts_state |
cliechti | 53edb47 | 2009-02-06 21:18:46 +0000 | [diff] [blame] | 808 | |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 809 | miniterm.start() |
cliechti | 258ab0a | 2011-03-21 23:03:45 +0000 | [diff] [blame] | 810 | try: |
| 811 | miniterm.join(True) |
| 812 | except KeyboardInterrupt: |
| 813 | pass |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 814 | if not options.quiet: |
| 815 | sys.stderr.write("\n--- exit ---\n") |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 816 | miniterm.join() |
cliechti | bf6bb7d | 2006-03-30 00:28:18 +0000 | [diff] [blame] | 817 | |
cliechti | 5370cee | 2013-10-13 03:08:19 +0000 | [diff] [blame] | 818 | # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - |
cliechti | 8b3ad39 | 2002-03-03 20:12:21 +0000 | [diff] [blame] | 819 | if __name__ == '__main__': |
cliechti | 6385f2c | 2005-09-21 19:51:19 +0000 | [diff] [blame] | 820 | main() |