Skip to content

Commit

Permalink
pyterm: added some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@OlegHahm
OlegHahm committed Aug 1, 2014
1 parent aaccb81 commit 9a09cba
Showing 1 changed file with 105 additions and 6 deletions.
111 changes: 105 additions & 6 deletions dist/tools/pyterm/pyterm.py
View file
Expand Up @@ -7,14 +7,16 @@
import ConfigParser as configparser


import cmd, serial, socket, sys, threading, readline, time, logging, os, argparse, re, codecs, signal
import cmd, serial, socket, sys, threading, readline, time, logging, os, \
argparse, re, codecs, signal

### import twisted if available, define dummy classes otherwise
try:
from twisted.internet import reactor
from twisted.internet.protocol import Protocol, ReconnectingClientFactory
except ImportError:
logging.getLogger("").warn("Twisted not available, please install it if you want to use pyterm's JSON capabilities")
logging.getLogger("").warn("Twisted not available, please install it if you"
"want to use pyterm's JSON capabilities")

class Protocol():
def __init__(self):
Expand All @@ -27,15 +29,43 @@ def __init__(self):
import platform
defaulthostname = platform.node()

### default serial port
defaultport = "/dev/ttyUSB0"

### default baudrate for serial connection
defaultbaud = 115200

### directory to store configuration and log files
defaultdir = os.environ['HOME'] + os.path.sep + '.pyterm'

### configuration file name
defaultfile = "pyterm-" + defaulthostname + ".conf"

### logging subfolder
defaultrunname = "default-run"

class SerCmd(cmd.Cmd):
"""Main class for pyterm based on Python's Cmd class.
Runs an interactive terminal that transfer between stdio and serial port.
"""

def __init__(self, port=None, baudrate=None, tcp_serial=None, confdir=None,
conffile=None, host=None, run_name=None):
"""Constructor.
Args:
port (str): serial port
baudrate (int): serial baudrate
tcp_serial (iht): TCP port to connect to (alternatively)
confdir (str): configuration directory
conffile (str): configuration file name
host (str): local host name
run_name (str): identifier for log filer subdirectory
"""

def __init__(self, port=None, baudrate=None, tcp_serial=None, confdir=None, conffile=None, host=None, run_name=None):
# initialize class members
cmd.Cmd.__init__(self)
self.port = port
self.baudrate = baudrate
Expand All @@ -62,6 +92,7 @@ def __init__(self, port=None, baudrate=None, tcp_serial=None, confdir=None, conf
self.init_cmd = []
self.load_config()

# check for a history file
try:
readline.read_history_file()
except IOError:
Expand All @@ -78,7 +109,8 @@ def __init__(self, port=None, baudrate=None, tcp_serial=None, confdir=None, conf
directory = self.configdir + os.path.sep + self.host
if not os.path.exists(directory):
os.makedirs(directory)
logging.basicConfig(filename=directory + os.path.sep + self.run_name + '.log', level=logging.DEBUG, format=fmt_str)
logging.basicConfig(filename=directory + os.path.sep + self.run_name + '.log', \
level=logging.DEBUG, format=fmt_str)
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

Expand All @@ -93,12 +125,18 @@ def __init__(self, port=None, baudrate=None, tcp_serial=None, confdir=None, conf


def preloop(self):
"""Executed bat program start.
"""

# if no serial or TCP is specified use default serial port
if not self.port and not self.tcp_serial:
sys.stderr.write("No port specified, using default (%s)!\n" % (defaultport))
self.port = defaultport
# if a TCP port is specified try to connect
if self.tcp_serial:
self.logger.info("Connect to localhost:%s" % self.tcp_serial)
for res in socket.getaddrinfo('localhost', self.tcp_serial, socket.AF_UNSPEC, socket.SOCK_STREAM):
for res in socket.getaddrinfo('localhost', self.tcp_serial, \
socket.AF_UNSPEC, socket.SOCK_STREAM):
af, socktype, proto, canonname, sa = res
try:
s = fdsocket(af, socktype, proto)
Expand All @@ -115,14 +153,17 @@ def preloop(self):
if s:
self.ser = s
else:
self.logger.error("Something went wrong connecting to localhost:%s" % self.tcp_serial)
self.logger.error("Something went wrong connecting to localhost:%s"
% self.tcp_serial)
sys.exit(1)
# otherwise go for the serial port
elif self.port:
self.logger.info("Connect to serial port %s" % self.port)
self.ser = serial.Serial(port=self.port, baudrate=self.baudrate, dsrdtr=0, rtscts=0)
self.ser.setDTR(0)
self.ser.setRTS(0)

# wait until connection is established and fire startup commands to the node
time.sleep(1)
for cmd in self.init_cmd:
self.logger.debug("WRITE ----->>>>>> '" + cmd + "'\n")
Expand All @@ -134,38 +175,56 @@ def preloop(self):
receiver_thread.start()

def precmd(self, line):
"""Check for command prefixes to distinguish between Pyterm interal
commands and commands that should be send to the node.
"""
self.logger.debug("processing line #%s#" % line)
if (line.startswith("/")):
return "PYTERM_" + line[1:]
return line

def default(self, line):
"""In case of no Pyterm specific prefix is detected, split string by
colons and send it to the node.
"""
self.logger.debug("%s is no pyterm command, sending to default out" % line)
for tok in line.split(';'):
tok = self.get_alias(tok)
self.ser.write((tok.strip() + "\n").encode("utf-8"))

def do_help(self, line):
"""Do not use Cmd's internal help function, but redirect to the node.
"""
self.ser.write("help\n".encode("utf-8"))

def complete_date(self, text, line, begidx, endidm):
"""Auto completion for date string.
"""
date = time.strftime("%Y-%m-%d %H:%M:%S")
return ["{}".format(date)]

def do_PYTERM_reset(self, line):
"""Pyterm command: Send a reset to the node.
"""
self.ser.setDTR(1)
self.ser.setDTR(0)

def do_PYTERM_exit(self, line, unused=None):
"""Pyterm command: Exit Pyterm.
"""
self.logger.info("Exiting Pyterm")
# save history file
readline.write_history_file()
# shut down twisted if running
if reactor.running:
reactor.callFromThread(reactor.stop)
if self.tcp_serial:
self.ser.close()
return True

def do_PYTERM_save(self, line):
"""Pyterm command: Save Pyterm configuration to file.
"""
if not self.config.has_section("general"):
self.config.add_section("general")
self.config.set("general", "port", self.port)
Expand Down Expand Up @@ -211,10 +270,14 @@ def do_PYTERM_save(self, line):
self.logger.info("Config saved")

def do_PYTERM_show_config(self, line):
"""Pyterm command: Show current configuration.
"""
for key in self.__dict__:
print(str(key) + ": " + str(self.__dict__[key]))

def do_PYTERM_alias(self, line):
"""Pyterm command: Register an alias or show an list of all registered aliases.
"""
if line.endswith("list"):
for alias in self.aliases:
self.logger.info("{} = {}".format(alias, self.aliases[alias]))
Expand All @@ -228,16 +291,22 @@ def do_PYTERM_alias(self, line):
self.aliases[alias] = command

def do_PYTERM_rmalias(self, line):
"""Pyterm command: Unregister an alias.
"""
if not self.aliases.pop(line, None):
sys.stderr.write("Alias not found")

def get_alias(self, tok):
"""Internal function to check for aliases.
"""
for alias in self.aliases:
if tok.split()[0] == alias:
return self.aliases[alias] + tok[len(alias):]
return tok

def do_PYTERM_trigger(self, line):
"""Pyterm command: Register an trigger Regex.
"""
if not line.count("="):
sys.stderr.write("Usage: /trigger <regex> = <CMD>\n")
return
Expand All @@ -247,13 +316,19 @@ def do_PYTERM_trigger(self, line):
self.triggers[re.compile(trigger)] = action

def do_PYTERM_rmtrigger(self, line):
"""Pyterm command: Unregister an trigger.
"""
if not self.triggers.pop(line, None):
sys.stderr.write("Trigger not found")

def do_PYTERM_ignore(self, line):
"""Pyterm command: Ignore lines with these Regexes matching.
"""
self.ignores.append(re.compile(line.strip()))

def do_PYTERM_unignore(self, line):
"""Pyterm command: Remote an ignore Regex.
"""
for r in self.ignores:
if (r.pattern == line.strip()):
self.logger.info("Remove ignore for %s" % r.pattern)
Expand All @@ -262,9 +337,13 @@ def do_PYTERM_unignore(self, line):
sys.stderr.write("Ignore for %s not found\n" % line.strip())

def do_PYTERM_filter(self, line):
"""Pyterm command: Show only lines matching this Regex.
"""
self.filters.append(re.compile(line.strip()))

def do_PYTERM_unfilter(self, line):
"""Pyterm command: Remove a filter.
"""
for r in self.filters:
if (r.pattern == line.strip()):
self.logger.info("Remove filter for %s" % r.pattern)
Expand All @@ -273,16 +352,24 @@ def do_PYTERM_unfilter(self, line):
sys.stderr.write("Filter for %s not found\n" % line.strip())

def do_PYTERM_json(self, line):
"""Pyterm command: Transfer lines matching this Regex as JSON object.
"""
self.json_regs[line.split(' ')[0].strip()] = re.compile(line.partition(' ')[2].strip())

def do_PYTERM_unjson(self, line):
"""Pyterm command: Remove a JSON filter.
"""
if not self.aliases.pop(line, None):
sys.stderr.write("JSON regex with ID %s not found" % line)

def do_PYTERM_init(self, line):
"""Pyterm command: Add an startup command. (Only useful in addition with /save).
"""
self.init_cmd.append(line.strip())

def load_config(self):
"""Internal function to laod configuration from file.
"""
self.config = configparser.SafeConfigParser()
self.config.read([self.configdir + os.path.sep + self.configfile])

Expand Down Expand Up @@ -312,6 +399,11 @@ def load_config(self):
self.__dict__[opt] = self.config.get(sec, opt)

def process_line(self, line):
"""Processes a valid line from node that should be printed and possibly forwarded.
Args:
line (str): input from node.
"""
self.logger.info(line)
# check if line matches a trigger and fire the command(s)
for trigger in self.triggers:
Expand Down Expand Up @@ -345,6 +437,11 @@ def process_line(self, line):
self.factory.myproto.sendMessage(json_obj)

def handle_line(self, line):
"""Handle line from node and check for further processing requirements.
Args:
line (str): input line from node.
"""
# First check if line should be ignored
ignored = False
if (len(self.ignores)):
Expand All @@ -369,9 +466,11 @@ def reader(self):
"""
output = ""
while (1):
# check if serial port can be accessed.
try:
sr = codecs.getreader("UTF-8")(self.ser, errors='replace')
c = sr.read(1)
# try to re-open it with a timeout of 1s otherwise
except (serial.SerialException, ValueError) as se:
self.logger.warn("Serial port disconnected, waiting to get reconnected...")
self.ser.close()
Expand Down

0 comments on commit 9a09cba

Please sign in to comment.