-
Notifications
You must be signed in to change notification settings - Fork 9
/
cli.py
executable file
·524 lines (408 loc) · 14.9 KB
/
cli.py
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
#!/usr/bin/env python3
# rene-d 2020
# modified pyserial terminal for wifinfo
#
# This file is part of pySerial. https://github.com/pyserial/pyserial
# (C)2002-2015 Chris Liechti <cliechti@gmx.net>
#
# SPDX-License-Identifier: BSD-3-Clause
import atexit
import codecs
import datetime
import fcntl
import sys
import termios
import threading
import click
import serial
from serial.tools import hexlify_codec
from serial.tools.list_ports import comports
from simutic import tic
# pylint: disable=wrong-import-order,wrong-import-position
codecs.register(lambda c: hexlify_codec.getregentry() if c == "hexlify" else None)
class Periodic(threading.Thread):
""" Timer périodique """
def __init__(self, interval, function):
self.interval = interval
self.function = function
threading.Thread.__init__(self)
self.stopped = threading.Event()
def stop(self):
self.stopped.set()
def run(self):
while not self.stopped.wait(self.interval):
self.function()
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
class ConsoleBase(object):
"""OS abstraction for console (input/output codec, no echo)"""
def __init__(self):
if sys.version_info >= (3, 0):
self.byte_output = sys.stdout.buffer
else:
self.byte_output = sys.stdout
self.output = sys.stdout
def setup(self):
"""Set console to read single characters, no echo"""
def cleanup(self):
"""Restore default console settings"""
def getkey(self):
"""Read a single key from the console"""
return None
def write_bytes(self, byte_string):
"""Write bytes (already encoded)"""
self.byte_output.write(byte_string)
self.byte_output.flush()
def write(self, text):
"""Write string"""
self.output.write(text)
self.output.flush()
def cancel(self):
"""Cancel getkey operation"""
# - - - - - - - - - - - - - - - - - - - - - - - -
# context manager:
# switch terminal temporary to normal mode (e.g. to get user input)
def __enter__(self):
self.cleanup()
return self
def __exit__(self, *args, **kwargs):
self.setup()
class Console(ConsoleBase):
def __init__(self):
super(Console, self).__init__()
self.fd = sys.stdin.fileno()
self.old = termios.tcgetattr(self.fd)
atexit.register(self.cleanup)
if sys.version_info < (3, 0):
self.enc_stdin = codecs.getreader(sys.stdin.encoding)(sys.stdin)
else:
self.enc_stdin = sys.stdin
def setup(self):
new = termios.tcgetattr(self.fd)
new[3] = new[3] & ~termios.ICANON & ~termios.ECHO & ~termios.ISIG
new[6][termios.VMIN] = 1
new[6][termios.VTIME] = 0
termios.tcsetattr(self.fd, termios.TCSANOW, new)
def getkey(self):
c = self.enc_stdin.read(1)
if c == chr(0x7F):
c = chr(8) # map the BS key (which yields DEL) to backspace
return c
def cancel(self):
fcntl.ioctl(self.fd, termios.TIOCSTI, b"\0")
def cleanup(self):
termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.old)
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
class Transform(object):
""" Do-nothing: forward all data unchanged """
def rx(self, text):
""" Text received from serial port """
return text
def tx(self, text):
""" Text to be sent to serial port """
return text
def echo(self, text):
""" Text to be sent but displayed on console """
return text
class CRLF(Transform):
""" ENTER sends CR+LF """
def tx(self, text):
return text.replace("\n", "\r\n")
class CR(Transform):
"""ENTER sends CR"""
def rx(self, text):
return text.replace("\r", "\n")
def tx(self, text):
return text.replace("\n", "\r")
class LF(Transform):
"""ENTER sends LF"""
class NoTerminal(Transform):
"""remove typical terminal control codes from input"""
REPLACEMENT_MAP = dict(
(x, 0x2400 + x) for x in range(32) if chr(x) not in "\r\n\b\t"
)
REPLACEMENT_MAP.update(
{0x7F: 0x2421, 0x9B: 0x2425,} # DEL # CSI
)
def rx(self, text):
return text.translate(self.REPLACEMENT_MAP)
echo = rx
class NoControls(NoTerminal):
"""Remove all control codes, incl. CR+LF"""
REPLACEMENT_MAP = dict((x, 0x2400 + x) for x in range(32))
REPLACEMENT_MAP.update(
{0x20: 0x2423, 0x7F: 0x2421, 0x9B: 0x2425,} # visual space # DEL # CSI
)
class Printable(Transform):
"""Show decimal code for all non-ASCII characters and replace most control codes"""
def rx(self, text):
r = []
for c in text:
if " " <= c < "\x7f" or c in "\r\n\b\t":
r.append(c)
elif c < " ":
r.append(chr(0x2400 + ord(c)))
else:
r.extend(chr(0x2080 + ord(d) - 48) for d in "{:d}".format(ord(c)))
r.append(" ")
return "".join(r)
echo = rx
class Colorize(Transform):
"""Apply different colors for received and echo"""
def __init__(self):
# XXX make it configurable, use colorama?
self.input_color = "\033[36m"
self.echo_color = "\033[31m"
def rx(self, text):
return self.input_color + text
def echo(self, text):
return self.echo_color + text
class DebugIO(Transform):
"""Print what is sent and received"""
def rx(self, text):
sys.stderr.write(" [RX:{}] ".format(repr(text)))
sys.stderr.flush()
return text
def tx(self, text):
sys.stderr.write(" [TX:{}] ".format(repr(text)))
sys.stderr.flush()
return text
# other ideas:
# - add date/time for each newline
# - insert newline after: a) timeout b) packet end character
EOL_TRANSFORMATIONS = {
"crlf": CRLF,
"cr": CR,
"lf": LF,
}
TRANSFORMATIONS = {
"direct": Transform, # no transformation
"default": NoTerminal,
"nocontrol": NoControls,
"printable": Printable,
"colorize": Colorize,
"debug": DebugIO,
}
class Miniterm(object):
"""
Terminal application. Copy data from serial port to console and vice versa.
Handle special keys from the console to show menu etc.
"""
def __init__(self, serial_instance, echo=False, eol="crlf", filters=()):
self.console = Console()
self.serial = serial_instance
self.echo = echo
self.input_encoding = "UTF-8"
self.output_encoding = "UTF-8"
self.eol = eol
self.filters = filters
self.update_transformations()
self.alive = None
self._reader_alive = None
self.receiver_thread = None
self.rx_decoder = None
self.tx_decoder = None
self.pause_tic = True
def _start_reader(self):
"""Start reader thread"""
self._reader_alive = True
# start serial->console thread
self.receiver_thread = threading.Thread(target=self.reader, name="rx")
self.receiver_thread.daemon = True
self.receiver_thread.start()
def _stop_reader(self):
"""Stop reader thread only, wait for clean exit of thread"""
self._reader_alive = False
if hasattr(self.serial, "cancel_read"):
self.serial.cancel_read()
self.receiver_thread.join()
def start(self):
"""start worker threads"""
self.alive = True
self._start_reader()
self.tic_thread = Periodic(self.frequence_trames, self.send_tic_periodic)
self.tic_thread.daemon = True
self.tic_thread.start()
# enter console->serial loop
self.transmitter_thread = threading.Thread(target=self.writer, name="tx")
self.transmitter_thread.daemon = True
self.transmitter_thread.start()
self.console.setup()
def stop(self):
"""set flag to stop worker threads"""
self.alive = False
def join(self, transmit_only=False):
"""wait for worker threads to terminate"""
self.transmitter_thread.join()
self.tic_thread.stop()
self.tic_thread.join()
if not transmit_only:
if hasattr(self.serial, "cancel_read"):
self.serial.cancel_read()
self.receiver_thread.join()
def close(self):
self.serial.close()
def update_transformations(self):
"""take list of transformation classes and instantiate them for rx and tx"""
transformations = [EOL_TRANSFORMATIONS[self.eol]] + [
TRANSFORMATIONS[f] for f in self.filters
]
self.tx_transformations = [t() for t in transformations]
self.rx_transformations = list(reversed(self.tx_transformations))
def set_rx_encoding(self, encoding, errors="replace"):
"""set encoding for received data"""
self.input_encoding = encoding
self.rx_decoder = codecs.getincrementaldecoder(encoding)(errors)
def set_tx_encoding(self, encoding, errors="replace"):
"""set encoding for transmitted data"""
self.output_encoding = encoding
self.tx_encoder = codecs.getincrementalencoder(encoding)(errors)
def reader(self):
"""loop and copy serial->console"""
try:
while self.alive and self._reader_alive:
# read all that is there or wait for one byte
data = self.serial.read(self.serial.in_waiting or 1)
if data:
text = self.rx_decoder.decode(data)
for transformation in self.rx_transformations:
text = transformation.rx(text)
self.console.write(text)
except serial.SerialException:
self.alive = False
self.console.cancel()
raise # XXX handle instead of re-raise?
def writer(self):
"""\
Loop and copy console->serial until self.exit_character character is
found. When self.menu_character is found, interpret the next key
locally.
"""
try:
while self.alive:
try:
c = self.console.getkey()
except KeyboardInterrupt:
c = "\x03"
if not self.alive:
break
elif c == chr(0x14): # Ctrl-T
self.send_tic()
elif c == chr(0x19): # Ctrl-Y
self.pause_tic = not self.pause_tic
elif c == chr(0x10): # Ctrl-P
tic.bascule("T")
self.send_tic()
elif c == chr(0x01): # Ctrl-A
tic.bascule("A")
self.send_tic()
elif c == chr(0x04): # Ctrl-D
tic.bascule("P")
self.send_tic()
elif c == chr(0x03): # Ctrl-C
self.stop() # exit app
break
else:
if ord(c) < 32:
print("\033[36;2m<%02x>\033[0m" % ord(c))
text = c
for transformation in self.tx_transformations:
text = transformation.tx(text)
self.serial.write(self.tx_encoder.encode(text))
if self.echo:
echo_text = c
for transformation in self.tx_transformations:
echo_text = transformation.echo(echo_text)
self.console.write(echo_text)
except Exception:
self.alive = False
raise
def send_tic_periodic(self):
if not self.pause_tic:
self.send_tic()
def send_tic(self):
time = datetime.datetime.now().strftime("%H:%M:%S.%f")
echo_text = f"{time} trame TIC\n"
for transformation in self.tx_transformations:
echo_text = transformation.echo(echo_text)
self.console.write(echo_text)
self.serial.write(tic.trame())
def ask_for_port():
"""\
Show a list of ports and ask the user for a choice. To make selection
easier on systems with long device names, also allow the input of an
index.
"""
# filtre les ports impossibles
ports = []
for comport in sorted(comports()):
if comport[0].startswith("/dev/cu.") and not comport[0].startswith(
"/dev/cu.usb"
):
continue
ports.append(comport)
if len(ports) == 1:
return ports[0][0]
sys.stderr.write("\n--- Available ports:\n")
for n, (port, desc, _) in enumerate(ports, 1):
sys.stderr.write("--- {:2}: {:20} {!r}\n".format(n, port, desc))
while True:
port = input("--- Enter port index or full name: ")
try:
index = int(port) - 1
if not 0 <= index < len(ports):
sys.stderr.write("--- Invalid index!\n")
continue
except ValueError:
pass
else:
port = ports[index][0]
return port
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@click.command(help="Terminal série modifié pour Téléinformation")
@click.help_option("-h", "--help", help="affiche l'aide")
@click.argument("port", envvar="COMPORT", default="")
@click.option("-t", "tinfo_baudrate", help="utilise 1200,7E1 (téléinfo)", is_flag=True)
@click.option(
"-f",
"--freq",
"frequence_trames",
help="fréquence d'envoi des trames",
default=1.424,
show_default=True,
type=click.FloatRange(1, 60),
)
@click.option(
"-a", "pause_tic", help="téléinfo automatique", is_flag=True, default=True
)
def main(port, tinfo_baudrate, frequence_trames, pause_tic):
"""Command line tool, entry point"""
if port == "":
port = ask_for_port()
try:
serial_instance = serial.serial_for_url(port, 115200, do_not_open=True)
if not hasattr(serial_instance, "cancel_read"):
# enable timeout for alive flag polling if cancel_read is not available
serial_instance.timeout = 1
if tinfo_baudrate:
serial_instance.baudrate = 1200
serial_instance.bytesize = serial.SEVENBITS
serial_instance.parity = serial.PARITY_EVEN
serial_instance.open()
except serial.SerialException as e:
sys.stderr.write("could not open port {}: {}\n".format(port, e))
sys.exit(1)
tinfo_term = Miniterm(serial_instance, echo=False, eol="crlf", filters=["colorize"])
tinfo_term.set_rx_encoding("ascii")
tinfo_term.set_tx_encoding("ascii")
tinfo_term.frequence_trames = frequence_trames
tinfo_term.pause_tic = pause_tic
tinfo_term.start()
try:
tinfo_term.join(True)
except KeyboardInterrupt:
pass
tinfo_term.join()
tinfo_term.close()
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
if __name__ == "__main__":
main()