3
M]WV @ s d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZ e j dd ye
W n e k
rr e Z
e
ZY nX dd ZG dd d eZejd
krd dlZd dlZG d d d eZG d
d deZnDejdkrd dlZd dlZd dlZG dd deZnedjej G dd deZ G dd de Z G dd de Z G dd de Z G dd de Z!G d d d e!Z"G d d d e Z#G d d! d!e Z$G d"d# d#e Z%e e e d$Z&e e!e"e#e$e%d%Z'd&d' Z(G d(d) d)eZ)d.d+d,Z*e+d-kre* dS )/ N)comports)
hexlify_codecc C s | dkrt j S d S )NZhexlify)r getregentry)c r /usr/lib/python3.6/miniterm.py s r c C s. t | }|dk r"djt d| S t| S dS )z)generate a readable description for a key z Ctrl+{:c}@N)ordformatrepr) characterZ
ascii_coder r r key_description s r c @ sX e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dS ) ConsoleBasez8OS abstraction for console (input/output codec, no echo)c C s* t jdkrt jj| _nt j| _t j| _d S )N r )r r )sys version_infostdoutbuffer byte_outputoutput)selfr r r __init__, s
zConsoleBase.__init__c C s dS )z.Set console to read single characters, no echoNr )r r r r setup3 s zConsoleBase.setupc C s dS )z Restore default console settingsNr )r r r r cleanup6 s zConsoleBase.cleanupc C s dS )z"Read a single key from the consoleNr )r r r r getkey9 s zConsoleBase.getkeyc C s | j j| | j j dS )z Write bytes (already encoded)N)r writeflush)r Z byte_stringr r r write_bytes= s zConsoleBase.write_bytesc C s | j j| | j j dS )z Write stringN)r r r )r textr r r r B s zConsoleBase.writec C s dS )zCancel getkey operationNr )r r r r cancelG s zConsoleBase.cancelc C s | j | S )N)r )r r r r __enter__N s zConsoleBase.__enter__c O s | j d S )N)r )r argskwargsr r r __exit__R s zConsoleBase.__exit__N)
__name__
__module__ __qualname____doc__r r r r r r r! r" r% r r r r r ) s r ntc @ s( e Zd ZdZdd Zdd Zdd ZdS ) Outz$file-like wrapper that uses os.writec C s
|| _ d S )N)fd)r r, r r r r ] s z Out.__init__c C s d S )Nr )r r r r r ` s z Out.flushc C s t j| j| d S )N)osr r, )r sr r r r c s z Out.writeN)r& r' r( r) r r r r r r r r+ Z s r+ c s4 e Zd Z fddZdd Zdd Zdd Z ZS ) Consolec s t t| j tjjj | _tjjj | _ tjjj
d tjjj d t j
dttjj d| _t j
dttjj dt_| jt_d| j_d S )Ni zUTF-8replace)superr/ r ctypeswindllkernel32ZGetConsoleOutputCP
_saved_ocpZ GetConsoleCP
_saved_icpSetConsoleOutputCP SetConsoleCPcodecs getwriterr+ r r filenor stderrencoding)r ) __class__r r r g s zConsole.__init__c C s$ t jjj| j t jjj| j d S )N)r2 r3 r4 r7 r5 r8 r6 )r r r r __del__s s zConsole.__del__c C sH xBt j }|tdkr tdS |tdtdfkr r r/ f s
r/ posixc s< e Zd Z fddZdd Zdd Zdd Zd d
Z ZS ) r/ c sr t t| j tjj | _tj \| _ | _
t j | j| _
tj| j tjdk rftjtjjtj| _ntj| _d S )Nr r )r r )r1 r/ r r stdinr; r, r- pipepipe_rpipe_wtermios tcgetattroldatexitregisterr r r9 getreaderr= enc_stdin)r )r> r r r s
zConsole.__init__c C sb t j| j}|d t j @ t j @ t j @ |d< d|d t j< d|d t j< t j| jt j | d S )Nr r )
rM rN r, ZICANONZECHOZISIGZVMINZVTIME tcsetattrZTCSANOW)r newr r r r s
$z
Console.setupc C s^ t j | j| jgg g d \}}}| j|kr:tj| jd d S | jjd}|tdkrZtd}|S )NrT )selectrS rK r- readrD )r Zready_r r r r r s
zConsole.getkeyc C s t j| jd d S )Nx)r- r rL )r r r r r! s zConsole.cancelc C s t j| jt j| j d S )N)rM rV r, Z TCSAFLUSHrO )r r r r r s zConsole.cleanup) r& r' r( r r r r! r rG r r )r> r r/ s
z9Sorry no implementation for your platform ({}) available.c @ s( e Zd ZdZdd Zdd Zdd ZdS ) Transformz&do-nothing: forward all data unchangedc C s |S )z text received from serial portr )r r r r r rx s z Transform.rxc C s |S )z text to be sent to serial portr )r r r r r tx s z Transform.txc C s |S )z(text to be sent but displayed on consoler )r r r r r echo s zTransform.echoN)r& r' r( r) r_ r` ra r r r r r^ s r^ c @ s e Zd ZdZdd ZdS )CRLFzENTER sends CR+LFc C s |j ddS )N
z
)r0 )r r r r r r` s zCRLF.txN)r& r' r( r) r` r r r r rb s rb c @ s e Zd ZdZdd Zdd ZdS )CRzENTER sends CRc C s |j ddS )N
rc )r0 )r r r r r r_ s zCR.rxc C s |j ddS )Nrc re )r0 )r r r r r r` s zCR.txN)r& r' r( r) r_ r` r r r r rd s rd c @ s e Zd ZdZdS )LFzENTER sends LFN)r& r' r( r) r r r r rf s rf c @ sB e Zd ZdZedd edD Zejddd dd ZeZ d
S )
NoTerminalz0remove typical terminal control codes from inputc c s& | ] }t |d kr|d| fV qdS )z
i $ N)rD ).0r] r r r s zNoTerminal.r i!$ i%$ )rX c C s |j | jS )N) translateREPLACEMENT_MAP)r r r r r r_ s z
NoTerminal.rxN)
r& r' r( r) dictrangerl updater_ ra r r r r rg s
rg c @ s8 e Zd ZdZedd edD Zejdddd d S )
NoControlsz%Remove all control codes, incl. CR+LFc c s | ]}|d | fV qdS )i $ Nr )rh r] r r r ri s zNoControls.r i#$ i!$ i%$ )r rX rj N)r& r' r( r) rm rn rl ro r r r r rp s rp c @ s e Zd ZdZdd ZeZdS ) PrintablezMShow decimal code for all non-ASCII characters and replace most control codesc C s g }x|D ]x}d| ko dk n s.|dkr:|j | q
|dk rZ|j tdt| q
|jdd djt|D |j d q
W dj|S ) N z
i $ c s s" | ]}t d t| d V qdS )i 0 N)rD r )rh dr r r ri s z Printable.rx..z{:d} )appendrD r extendr join)r r rr r r r r_ s
z Printable.rxN)r& r' r( r) r_ ra r r r r rq s rq c @ s( e Zd ZdZdd Zdd Zdd ZdS ) Colorizez,Apply different colors for received and echoc C s d| _ d| _d S )Nz[37mz[31m) input_color
echo_color)r r r r r
s zColorize.__init__c C s
| j | S )N)r| )r r r r r r_ s z Colorize.rxc C s
| j | S )N)r} )r r r r r ra s z
Colorize.echoN)r& r' r( r) r r_ ra r r r r r{
s r{ c @ s e Zd ZdZdd Zdd ZdS )DebugIOz Print what is sent and receivedc C s$ t jjdjt| t jj |S )Nz [RX:{}] )r r< r r r
r )r r r r r r_ s
z
DebugIO.rxc C s$ t jjdjt| t jj |S )Nz [TX:{}] )r r< r r r
r )r r r r r r` ! s
z
DebugIO.txN)r& r' r( r) r_ r` r r r r r~ s r~ )crlfZcrZlf)ZdirectdefaultZ nocontrolZ printableZcolorizedebugc C s t jjd g } xBttt dD ].\}\}}}t jjdj||| | j| q"W xdtd}y:t |d }d| kot
| k n st jjd wVW n t k
r Y n
X | | }|S dS )z 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.
z
--- Available ports:
rT z--- {:2}: {:20} {}
z#--- Enter port index or full name: r z--- Invalid index!
N) r r< r enumeratesortedr r rw raw_inputintlen
ValueError)ZportsnportZdescZhwidindexr r r ask_for_port< s r c @ s e Zd ZdZddf fddZdd Zdd Zd
d Zd d
Zd$ddZ dd Z
dd Z d%ddZ d&ddZ
dd Zdd Zd d Zd d Zd!d" Zd#S )'Minitermz Terminal application. Copy data from serial port to console and vice versa.
Handle special keys from the console to show menu etc.
Fr c C sh t | _|| _|| _d| _d| _d| _|| _|| _| j d| _
d| _ d | _ d | _
d | _d | _d | _d S )NFzUTF-8 )r/ consoleserialra rawinput_encodingoutput_encodingeolfiltersupdate_transformationsexit_charactermenu_characteralive
_reader_alivereceiver_thread
rx_decoderZ
tx_decoder)r serial_instancera r r r r r r [ s zMiniterm.__init__c C s. d| _ tj| jdd| _d| j_| jj dS )zStart reader threadTr_ )targetnameN)r threadingThreadreaderr daemonstart)r r r r
_start_readerm s zMiniterm._start_readerc C s* d| _ t| jdr | jj | jj dS )z6Stop reader thread only, wait for clean exit of threadF cancel_readN)r hasattrr r r ry )r r r r _stop_readeru s
zMiniterm._stop_readerc C s@ d| _ | j tj| jdd| _d| j_| jj | jj dS )zstart worker threadsTr` )r r N)
r r r r writertransmitter_threadr r r r )r r r r r | s
zMiniterm.startc C s
d| _ dS )z set flag to stop worker threadsFN)r )r r r r stop s z
Miniterm.stopc C s2 | j j |s.t| jdr$| jj | jj dS )z$wait for worker threads to terminater N)r ry r r r r )r Z
transmit_onlyr r r ry s
z
Miniterm.joinc C s | j j d S )N)r close)r r r r r s zMiniterm.closec C s@ t | j gdd | jD }dd |D | _tt| j| _dS )zFtake list of transformation classes and instantiate them for rx and txc S s g | ] }t | qS r )TRANSFORMATIONS)rh fr r r
s z3Miniterm.update_transformations..c S s g | ]
}| qS r r )rh tr r r r s N)EOL_TRANSFORMATIONSr r tx_transformationslistreversedrx_transformations)r Ztransformationsr r r r s z Miniterm.update_transformationsr0 c C s || _ tj||| _dS )z set encoding for received dataN)r r9 getincrementaldecoderr )r r= errorsr r r set_rx_encoding s zMiniterm.set_rx_encodingc C s || _ tj||| _dS )z!set encoding for transmitted dataN)r r9 getincrementalencoder
tx_encoder)r r= r r r r set_tx_encoding s zMiniterm.set_tx_encodingc C sN t jjdj| jd t jjdj| jjr,dnd| jjr:dnd| jjrHdnd yLt jjdj| jjrhdnd| jj rvdnd| jj
rdnd| jj rdnd W n tj k
r Y nX t jjdj| jj
rdnd t jjdj| jjrdnd t jjd j| j t jjd
j| j t jjd j| jj t jjd jd
j| j dS )z$Write current settings to sys.stderrzK
--- Settings: {p.name} {p.baudrate},{p.bytesize},{p.parity},{p.stopbits}
)pz&--- RTS: {:8} DTR: {:8} BREAK: {:8}
activeinactivez---- CTS: {:8} DSR: {:8} RI: {:8} CD: {:8}
z --- software flow control: {}
z --- hardware flow control: {}
z --- serial input encoding: {}
z --- serial output encoding: {}
z --- EOL: {}
z--- filters: {}
rr N)r r< r r r rtsdtrbreak_conditionZctsZdsrZriZcdSerialExceptionxonxoffrtsctsr r r upperry r )r r r r dump_port_settings s(
zMiniterm.dump_port_settingsc C s ytxn| j rp| jrp| jj| jjp d}|r| jr<| jj| q| jj |}x| j
D ]}|j |}qPW | jj | qW W n( tj
k
r d| _ | jj Y nX dS )z loop and copy serial->consolerT FN)r r r r[ Z
in_waitingr r r r decoder r_ r r r! )r datar transformationr r r r s
zMiniterm.readerc C s d}yx| j ry| jj }W n tk
r4 d}Y nX | j s>P |rR| j| d}q|| jkrbd}q|| jkrx| j P q|}x| jD ]}|j |}qW | j
j | j j
| | jr|}x| jD ]}|j|}qW | jj | qW W n d| _ Y nX dS )z Loop and copy console->serial until self.exit_character character is
found. When self.menu_character is found, interpret the next key
locally.
FTN)r r r KeyboardInterrupthandle_menu_keyr r r r r` r r r encodera )r Z menu_activer r r Z echo_textr r r r s:
zMiniterm.writerc C s || j ks|| jkr>| jj| jj| | jr:| jj| nZ|dkr:tj jd tj j
| j tj j j
d}|r,yvt|dP}tj jdj| x6|jd}|sP | jj| | jj
tj jd qW W dQ R X tj jd j| W n8 tk
r* } ztj jd
j|| W Y dd}~X nX W dQ R X n^|d krXtj j| j n@|d kr| jj | j_tj jd
j| jjrdnd n|dkr| jj | j_tj jdj| jjrdnd n|dkr | jj | j_tj jdj| jjr dnd n|dkrB| j | _tj jdj| jr6dnd nV|dkr tj jd tj jdjdd ttj D tj jdjd j| j | j tj j j j }W dQ R X |r x>|D ](}|tkrtj jd jt | P qW || _| j tj jd jd j| j nz|d krt t }|j!| j"d }|t#|krRd!}|| | _"tj jd"j| j"j$ | j n|d#kr t5k
r: } z tj jd,j| | j6 W Y dd}~X n(X | jj6 | | _tj jd-j| jj0 | j7 n*|d.krtj jd/ tj j
| jp | jj8}
yt9tj j j& | j_8W n> t:k
r } z tj jd0j| |
| j_8W Y dd}~X n
X | j- W dQ R X n|d1kr.tj;| j_<| j- nj|d2krNtj=| j_<| j- nJ|d3krntj>| j_?| j- n*|d4krtj@| j_?| j- n
|d5krtjA| j_?| j- n|d6krtjB| j_?| j- n|d7krtjC| j_?| j- n|d8krtjD| j_E| j- n|d9kr$tjF| j_E| j- nt|d:krBtjG| j_E| j- nV|d;krb|dk| j_I| j- ntj jd?jtJ| dS )@z"Implement a simple menu / settingsz
--- File to upload: z
rbz--- Sending file {} ---
i .Nz
--- File {} sent ---
z"--- ERROR opening file {}: {} ---
zhH?z--- RTS {} ---
r r z--- DTR {} ---
z--- BREAK {} ---
z--- local echo {} ---
z
--- Available Filters:
rc c s s | ]\}}d j ||V qdS )z--- {:<10} = {.__doc__}N)r )rh kvr r r ri $ s z+Miniterm.handle_menu_key..z$
--- Enter new filter name(s) [{}]: rr z--- unknown filter: {}z--- filters: {}
rT r z--- EOL: {} ---
z#
--- Enter new encoding name [{}]: z --- invalid encoding name: {}
z --- serial input encoding: {}
z --- serial output encoding: {}
ZpPT) do_not_openz#--- ERROR opening new port: {} ---
z --- Port changed to: {} ---
ZbBz
--- Baudrate: z#--- ERROR setting baudrate: {} ---
87ZeEZoOZmMZsSZnN123ZxXXZrRRz!--- unknown menu character {} --
)Kr r r r r r ra r r r< r rI readlinerstripopenr r[ IOError
get_help_textr r r ry r r itemsr lowersplitr
r r r r r r r r stripr9 lookup LookupErrorr r r r r r r r ZgetSettingsDictserial_for_urlZapplySettingsDict Exceptionr r baudrater r Z EIGHTBITSZbytesizeZ SEVENBITSZ PARITY_EVENparityZ
PARITY_ODDZ PARITY_MARKZ PARITY_SPACEZ PARITY_NONEZ STOPBITS_ONEZstopbitsZ STOPBITS_TWOZSTOPBITS_ONE_POINT_FIVEr r r )r r filenamer blockeZ new_filtersZmodesr Z new_encodingr ZsettingsZ
new_serialZbackupr r r r s&
4
$
$
$
"
zMiniterm.handle_menu_keyc C sZ dj ttddt| jt| jtdtdtdtdtdtd td
td td d
S )zreturn the help textaQ
--- pySerial ({version}) - miniterm - help
---
--- {exit:8} Exit program
--- {menu:8} Menu escape key, followed by:
--- Menu keys:
--- {menu:7} Send the menu character itself to remote
--- {exit:7} Send the exit character itself to remote
--- {info:7} Show info
--- {upload:7} Upload file (prompt will be shown)
--- {repr:7} encoding
--- {filter:7} edit filters
--- Toggles:
--- {rts:7} RTS {dtr:7} DTR {brk:7} BREAK
--- {echo:7} echo {eol:7} EOL
---
--- Port settings ({menu} followed by the following):
--- p change port
--- 7 8 set data bits
--- N E O S M change parity (None, Even, Odd, Space, Mark)
--- 1 2 3 set stop bits (1, 2, 1.5)
--- b change baud rate
--- x X disable/enable software flow control
--- r R disable/enable hardware flow control
VERSIONzunknown versionr r r r r r r r r ) versionexitZmenur r Zbrkra infoZuploadr
filterr )r getattrr r r r )r r r r r s zMiniterm.get_help_textN)F)r0 )r0 )r& r' r( r) r r r r r ry r r r r r r r r r r r r r r U s"
& $r % c C s ddl }|jdd}|jddd| d |jd dtd
|d |jd }|jd
dddddgdd ddd |jddddd |jd dd dd |jd td |d |jd!td"|d |jd#dd$dd |jd%}|jd&d'dd(dd |jd)d*d+d,d-d. |jd/d0d1d2d3g d4 |jd5d6d7d8gd9d d:d8d |jd;ddtd?d@dAdB |jdCtd?dDdEdB |jdF}|jdGdHddIdd |jdJddKdd |j }|j|jkr|jdL |j r dM|j krt
j j dN t
j j dOj
dPdQ ttj D t
j j dO t
jdR |j }ndSg}x|jdks>|jdTkry t |_W n, tk
rv t
j j dO |jdU Y nX |js|jdV ytj|j|j|j|j|jdWdX} t| dYsdR| _ |j dk r|j st
j j dZj |j rd[nd\ |j | _ |j dk r2|j s*t
j j d]j |j r"d[nd\ |j | _ | j! W nd tj"k
r }
zDt
j j d^j t#|j|
|j$rv |j%st
jdR ndT|_W Y dd}
~
X nX P q&W t&| |j'|j(j) |d_} t*|j| _+t*|j| _,|j-| _-| j.|j/ | j0|j/ |j sFt
j j d`j | jda t
j j dbj t1| j+t1| j,t1| j,t1dc | j2 y| j
dW W n tk
rr Y nX |j st
j j dd | j
| j3 dS )ez Command line tool, entry pointr Nz9Miniterm - A simple terminal program for the serial port.) descriptionr ?z(serial port name ('-' to show port list))nargshelpr r z#set baud rate, default: %(default)s)r typer r z
port settingsz--parityNEOSMc S s | j S )N)r )r r r r r s zmain..z*set parity, one of {N E O S M}, default: N)choicesr r r z--rtscts
store_truez)enable RTS/CTS flow control (default off)F)actionr r z --xonxoffz*enable software flow control (default off)z--rtsz2set initial RTS line state (possible values: 0, 1))r r r z--dtrz2set initial DTR line state (possible values: 0, 1)z--askz"ask again for port when open failsz
data handlingz-ez--echoz enable local echo (default off)z
--encodingserial_port_encodingZCODECzXset the encoding for the serial port (e.g. hexlify, Latin1, UTF-8), default: %(default)szUTF-8)destmetavarr r z-fz--filterrw NAMEzadd text transformation)r r r r z--eolrd rf rb c S s | j S )N)r )r r r r r s zend of line modez--rawz)Do no apply any encodings/transformationsZhotkeysz --exit-charZNUMzWUnicode of special character that is used to exit the application, default: %(default)sr )r r r r z --menu-charz_Unicode code of special character that is used to control miniterm (menu), default: %(default)sr Z diagnosticsz-qz--quietzsuppress non-error messagesz --developz show Python traceback on errorz.--exit-char can not be the same as --menu-charr zAvailable filters:
rc c s s | ]\}}d j ||V qdS )z{:<10} = {.__doc__}N)r )rh r r r r r ri M s zmain..rT r -z"user aborted and port is not givenzport is not givenT)r r r r r z--- forcing DTR {}
r r z--- forcing RTS {}
zcould not open port {}: {}
)ra r r zP--- Miniterm on {p.name} {p.baudrate},{p.bytesize},{p.parity},{p.stopbits} ---
)r z6--- Quit: {} | Menu: {} | Help: {} followed by {} ---
z
--- exit ---
)4argparseArgumentParser add_argumentr Zadd_argument_group
parse_argsZ menu_charZ exit_charerrorr r r< r ry r r r r r r r r r r r r r r Ztimeoutr quietr r r r r
ZdevelopZaskr ra r r rD r r r r r r r r r ) Z default_portZdefault_baudrateZ default_rtsZ default_dtrr parsergroupr# r r r Zminitermr r r main s^
r __main__)Nr NN),r9 r- r r r Zserial.tools.list_portsr Z serial.toolsr rQ r NameErrorinputchrrD r objectr r rC r2 r+ r/ rP rM rZ NotImplementedErrorr platformr^ rb rd rf rg rp rq r{ r~ r r r r r r& r r r r
sh
-
!
&
t
[