Merge pull request #5 from openwsn-berkeley/develop

OV-10. xon/xoff feature support

bin/serialTesterCli/OpenCli.py

@@ -0,0 +1,248 @@
+#!/usr/bin/python
+
+import sys
+import threading
+import logging
+import binascii
+import time
+from   datetime import timedelta
+
+class NullLogHandler(logging.Handler):
+    def emit(self, record):
+        pass
+
+class OpenCli(threading.Thread):
+    '''
+    \brief Thread which handles CLI commands entered by the user.
+    '''
+
+    CMD_LEVEL_USER   = "user"
+    CMD_LEVEL_SYSTEM = "system"
+
+    def __init__(self,appName,quit_cb):
+
+        # slot params
+        self.appName         = appName
+        self.quit_cb         = quit_cb
+
+        # local variables
+        self.commandLock     = threading.Lock()
+        self.commands        = []
+        self.goOn            = True
+
+        # logging
+        self.log             = logging.getLogger('OpenCli')
+        self.log.setLevel(logging.DEBUG)
+        self.log.addHandler(NullLogHandler())
+
+        # initialize parent class
+        threading.Thread.__init__(self)
+
+        # give this thread a name
+        self.name            = 'OpenCli'
+
+        # register system commands (user commands registers by child object)
+        self._registerCommand_internal(
+                self.CMD_LEVEL_SYSTEM,
+                'help',
+                'h',
+                'print this menu',
+                [],
+                self._handleHelp)
+        self._registerCommand_internal(
+                self.CMD_LEVEL_SYSTEM,
+                'info',
+                'i',
+                'information about this application',
+                [],
+                self._handleInfo)
+        self._registerCommand_internal(
+                self.CMD_LEVEL_SYSTEM,
+                'quit',
+                'q',
+                'quit this application',
+                [],
+                self._handleQuit)
+        self._registerCommand_internal(
+                self.CMD_LEVEL_SYSTEM,
+                'uptime',
+                'ut',
+                'how long this application has been running',
+                [],
+                self._handleUptime)
+
+    def run(self):
+        print '{0} - OpenWSN project\n'.format(self.appName)
+
+        self.startTime = time.time()
+
+        while self.goOn:
+
+            # CLI stops here each time a user needs to call a command
+            params = raw_input('> ')
+
+            # log
+            self.log.debug('Following command entered:'+params)
+
+            params = params.split()
+            if len(params)<1:
+                continue
+
+            if len(params)==2 and params[1]=='?':
+                if not self._printUsageFromName(params[0]):
+                    if not self._printUsageFromAlias(params[0]):
+                        print ' unknown command or alias \''+params[0]+'\''
+                continue
+
+            # find this command
+            found = False
+            self.commandLock.acquire()
+            for command in self.commands:
+                if command['name']==params[0] or command['alias']==params[0]:
+                    found = True
+                    cmdParams     = command['params']
+                    cmdCallback   = command['callback']
+                    break
+            self.commandLock.release()
+
+            # call its callback or print error message
+            if found:
+                if len(params[1:])==len(cmdParams):
+                    cmdCallback(params[1:])
+                else:
+                    if not self._printUsageFromName(params[0]):
+                        self._printUsageFromAlias(params[0])
+            else:
+                print ' unknown command or alias \''+params[0]+'\''
+
+    #======================== public ==========================================
+
+    def registerCommand(self,name,alias,description,params,callback):
+
+        self._registerCommand_internal(self.CMD_LEVEL_USER,
+                                       name,
+                                       alias,
+                                       description,
+                                       params,
+                                       callback)
+
+    #======================== private =========================================
+
+    def _registerCommand_internal(self,cmdLevel,name,alias,description,params,callback):
+
+        if self._doesCommandExist(name):
+            raise SystemError("command {0} already exists".format(name))
+
+        self.commandLock.acquire()
+        self.commands.append({
+                                'cmdLevel':      cmdLevel,
+                                'name':          name,
+                                'alias':         alias,
+                                'description':   description,
+                                'params':        params,
+                                'callback':      callback,
+                             })
+        self.commandLock.release()
+
+    def _printUsageFromName(self,commandname):
+        return self._printUsage(commandname,'name')
+
+    def _printUsageFromAlias(self,commandalias):
+        return self._printUsage(commandalias,'alias')
+
+    def _printUsage(self,name,paramType):
+
+        usageString = None
+
+        self.commandLock.acquire()
+        for command in self.commands:
+            if command[paramType]==name:
+                usageString  = []
+                usageString += ['usage: {0}'.format(name)]
+                usageString += [" <{0}>".format(p) for p in command['params']]
+                usageString  = ''.join(usageString)
+        self.commandLock.release()
+
+        if usageString:
+            print usageString
+            return True
+        else:
+            return False
+
+    def _doesCommandExist(self,cmdName):
+
+        returnVal = False
+
+        self.commandLock.acquire()
+        for cmd in self.commands:
+            if cmd['name']==cmdName:
+                returnVal = True
+        self.commandLock.release()
+
+        return returnVal
+
+    #=== command handlers (system commands only, a child object creates more)
+
+    def _handleHelp(self,params):
+        output  = []
+        output += ['Available commands:']
+
+        self.commandLock.acquire()
+        for command in self.commands:
+            output += [' - {0} ({1}): {2}'.format(command['name'],
+                                                  command['alias'],
+                                                  command['description'])]
+        self.commandLock.release()
+
+        print '\n'.join(output)
+
+    def _handleInfo(self,params):
+        output  = []
+        output += ['General status of the application']
+        output += ['']
+        output += ['current time: {0}'.format(time.ctime())]
+        output += ['']
+        output += ['{0} threads running:'.format(threading.activeCount())]
+        for t in threading.enumerate():
+            output += ['- {0}'.format(t.getName())]
+        output += ['']
+        output += ['This is thread {0}.'.format(threading.currentThread().getName())]
+
+        print '\n'.join(output)
+
+    def _handleQuit(self,params):
+
+        # call the quit callback
+        self.quit_cb()
+
+        # kill this thead
+        self.goOn = False
+
+    def _handleUptime(self,params):
+
+        upTime = timedelta(seconds=time.time()-self.startTime)
+
+        print 'Running since {0} ({1} ago)'.format(
+                time.strftime("%m/%d/%Y %H:%M:%S",time.localtime(self.startTime)),
+                upTime)
+
+
+    #======================== helpers =========================================
+
+###############################################################################
+
+if __name__=='__main__':
+
+    def quitCallback():
+        print "quitting!"
+
+    def echoCallback(params):
+        print "echo {0}!".format(params)
+
+    cli = OpenCli("Standalone Sample App",quitCallback)
+    cli.registerCommand('echo',
+                        'e',
+                        'echoes the first param',
+                        ['string to echo'],
+                        echoCallback)
+    cli.start()