1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
#!/usr/bin/env python
# Very simple serial terminal
# (C)2002-2006 Chris Liechti <cliechti@gmx.net>
# Input characters are sent directly (only LF -> CR/LF/CRLF translation is
# done), received characters are displayed as is (or escaped trough pythons
# repr, useful for debug purposes)
import sys, os, serial, threading, getopt
EXITCHARCTER = '\x1d' #GS/ctrl+]
#first choose a platform dependant way to read single characters from the console
if os.name == 'nt':
import msvcrt
def getkey():
while 1:
z = msvcrt.getch()
if z == '\0' or z == '\xe0': #functions keys
msvcrt.getch()
else:
if z == '\r':
return '\n'
return z
elif os.name == 'posix':
import termios, sys, os
fd = sys.stdin.fileno()
old = termios.tcgetattr(fd)
new = termios.tcgetattr(fd)
new[3] = new[3] & ~termios.ICANON & ~termios.ECHO
new[6][termios.VMIN] = 1
new[6][termios.VTIME] = 0
termios.tcsetattr(fd, termios.TCSANOW, new)
def getkey():
c = os.read(fd, 1)
return c
def clenaup_console():
termios.tcsetattr(fd, termios.TCSAFLUSH, old)
sys.exitfunc = clenaup_console #terminal modes have to be restored on exit...
else:
raise "Sorry no implementation for your platform (%s) available." % sys.platform
CONVERT_CRLF = 2
CONVERT_CR = 1
CONVERT_LF = 0
NEWLINE_CONVERISON_MAP = ('\n', '\r', '\r\n')
class Miniterm:
def __init__(self, port, baudrate, parity, rtscts, xonxoff, echo=False, convert_outgoing=CONVERT_CRLF, repr_mode=False):
self.serial = serial.Serial(port, baudrate, parity=parity, rtscts=rtscts, xonxoff=xonxoff, timeout=0.7)
self.echo = echo
self.repr_mode = repr_mode
self.convert_outgoing = convert_outgoing
self.newline = NEWLINE_CONVERISON_MAP[self.convert_outgoing]
def start(self):
self.alive = True
#start serial->console thread
self.receiver_thread = threading.Thread(target=self.reader)
self.receiver_thread.setDaemon(1)
self.receiver_thread.start()
#enter console->serial loop
self.transmitter_thread = threading.Thread(target=self.writer)
self.transmitter_thread.setDaemon(1)
self.transmitter_thread.start()
def stop(self):
self.alive = False
def join(self, transmit_only=False):
self.transmitter_thread.join()
if not transmit_only:
self.receiver_thread.join()
def reader(self):
"""loop and copy serial->console"""
while self.alive:
data = self.serial.read(1)
if self.repr_mode:
sys.stdout.write(repr(data)[1:-1])
else:
if data == '\r' and self.convert_outgoing == CONVERT_CR:
sys.stdout.write('\n')
else:
sys.stdout.write(data)
sys.stdout.flush()
def writer(self):
"""loop and copy console->serial until EXITCHARCTER character is found"""
while self.alive:
try:
c = getkey()
except KeyboardInterrupt:
c = '\x03'
if c == EXITCHARCTER:
self.stop()
break # exit app
elif c == '\n':
self.serial.write(self.newline) # send newline character(s)
if self.echo:
sys.stdout.write(c) #local echo is a real newline in any case
else:
self.serial.write(c) # send character
if self.echo:
sys.stdout.write(c)
def main():
import optparse
parser = optparse.OptionParser(usage="""\
%prog [options]
Miniterm - A simple terminal program for the serial port.""")
parser.add_option("-p", "--port", dest="port",
help="port, a number (default = 0) or a device name", default=0)
parser.add_option("-b", "--baud", dest="baudrate", action="store", type='int',
help="set baudrate, default=9600", default=9600)
parser.add_option("", "--parity", dest="parity", action="store",
help="set parity, one of [N, E, O], default=N", default='N')
parser.add_option("-e", "--echo", dest="echo", action="store_true",
help="enable local echo (default off)", default=False)
parser.add_option("", "--rtscts", dest="rtscts", action="store_true",
help="enable RTS/CTS flow control (default off)", default=False)
parser.add_option("", "--xonxoff", dest="xonxoff", action="store_true",
help="enable software flow control (default off)", default=False)
parser.add_option("", "--cr", dest="cr", action="store_true",
help="do not send CR+LF, send CR only", default=False)
parser.add_option("", "--lf", dest="lf", action="store_true",
help="do not send CR+LF, send LF only", default=False)
parser.add_option("-D", "--debug", dest="repr_mode", action="store_true",
help="debug received data (escape nonprintable chars)", default=False)
parser.add_option("", "--rts", dest="rts_state", action="store", type='int',
help="set initial RTS line state (possible values: 0, 1)", default=None)
parser.add_option("", "--dtr", dest="dtr_state", action="store", type='int',
help="set initial DTR line state (possible values: 0, 1)", default=None)
parser.add_option("-q", "--quiet", dest="quiet", action="store_true",
help="suppress non error messages", default=False)
(options, args) = parser.parse_args()
if options.cr and options.lf:
parser.error("ony one of --cr or --lf can be specified")
if args:
parser.error("no arguments are allowed, options only")
convert_outgoing = CONVERT_CRLF
if options.cr:
convert_outgoing = CONVERT_CR
elif options.lf:
convert_outgoing = CONVERT_LF
try:
miniterm = Miniterm(
options.port,
options.baudrate,
options.parity,
rtscts=options.rtscts,
xonxoff=options.xonxoff,
echo=options.echo,
convert_outgoing=convert_outgoing,
repr_mode=options.repr_mode,
)
except serial.SerialException:
sys.stderr.write("could not open port %r" % options.port)
sys.exit(1)
if not options.quiet:
sys.stderr.write('--- Miniterm on "%s". Type Ctrl-] to quit. ---\n' % miniterm.serial.portstr)
if options.dtr_state is not None:
if not options.quiet:
sys.stderr.write('--- forcing DTR %s\n' % (options.dtr_state and 'active' or 'inactive'))
miniterm.serial.setDTR(options.dtr_state)
if options.rts_state is not None:
if not options.quiet:
sys.stderr.write('--- forcing RTS %s\n' % (options.rts_state and 'active' or 'inactive'))
miniterm.serial.setRTS(options.rts_state)
miniterm.start()
miniterm.join(True)
if not options.quiet:
sys.stderr.write("\n--- exit ---\n")
miniterm.join()
if __name__ == '__main__':
main()
|
