laelaps_diag.application Class Reference

Laelaps diagnositcs application class. More...

Public Member Functions
def	__init__ (self)
	Constructor.
def	printUsageErr (self, emsg)
	Print usage error. More...
def	printUsage (self)
	Print Command-Line Usage Message. More...
def	getOptions (self, argv=None, kwargs)
	Get command-line options. More...
def	run (self, argv=None, kwargs)
	Run application. More...

Public Attributes
	m_win
	kwargs

Detailed Description

Laelaps diagnositcs application class.

Definition at line 571 of file laelaps_diag.py.

Member Function Documentation

def laelaps_diag.application.getOptions	(		self,
			argv = None,
			kwargs
	)

Get command-line options.

Parameters

	argv	Argument list. If not None, then overrides command-line arguments.
[out]	kwargs	Keyword argument list.

Returns

Parsed keyword arguments.

Definition at line 626 of file laelaps_diag.py.

References laelaps_diag.application._Argv0, laelaps_diag.application.printUsage(), and laelaps_diag.application.printUsageErr().

Referenced by laelaps_sane.application.run(), laelaps_speed.application.run(), laelaps_diag.application.run(), laelaps_init.application.run(), and laelaps_tune_motors.application.run().

  def getOptions(self, argv=None, **kwargs):
    if argv is None:
      argv = sys.argv

    self._Argv0 = os.path.basename(kwargs.get('argv0', __file__))

    # defaults
    kwargs['debug'] = False
    kwargs['fake']  = False

    # parse command-line options
    try:
      opts, args = getopt.getopt(argv[1:], "f?h",
          ['help', 'fake', ''])
    except getopt.error, msg:
      raise usage(msg)
    for opt, optarg in opts:
      if opt in ('-f', '--fake'):
        kwargs['fake'] = True
      elif opt in ('-h', '--help', '-?'):
        self.printUsage()
        sys.exit(0)

    if len(args) < 1:
      self.printUsageErr("No diagnostic(s) specified.")
      sys.exit(128)
    try:
      args.index('all')
      kwargs['diags'] = Diagnostics
    except ValueError:
      kwargs['diags'] = args

    return kwargs

def laelaps_diag.application.printUsage

(

self

)

Print Command-Line Usage Message.

Definition at line 593 of file laelaps_diag.py.

References laelaps_diag.application._Argv0.

Referenced by laelaps_sane.application.getOptions(), laelaps_speed.application.getOptions(), laelaps_diag.application.getOptions(), laelaps_init.application.getOptions(), and laelaps_tune_motors.application.getOptions().

  def printUsage(self):
    print \
"""
usage: %s [OPTIONS] DIAG [DIAG ...]
       %s --help

Run Laelaps diagnostic(s).

Options and arguments:
    --fake        : Run diagnostics on fake hardware."
-h, --help        : Display this help and exit.

DIAG              : Diagnostic to run. One of:
  all       - Run all dignostics.
  motors    - Run motors diagnotics.
  tofs      - Run time-of-flight sensors diagnostics.
  imu       - Run Inertia Measurement Unit diagnostics.
  watchdog  - Run Arduino watchdog sub-processor diagnostics.

Exit Status:
  The number of diagnostics passed. An exit status of 128 indicates usage 
  error.
"""  % (self._Argv0, self._Argv0)
 

def laelaps_diag.application.printUsageErr	(		self,
			emsg
	)

Print usage error.

Parameters

emsg	Error message string.

Definition at line 585 of file laelaps_diag.py.

References laelaps_diag.application._Argv0.

Referenced by laelaps_sane.application.getOptions(), laelaps_speed.application.getOptions(), and laelaps_diag.application.getOptions().

  def printUsageErr(self, emsg):
    if emsg:
      print "%s: Error: %s" % (self._Argv0, emsg)
    else:
      print "%s: Error" % (self._Argv0)
    print "Try '%s --help' for more information." % (self._Argv0)

def laelaps_diag.application.run	(		self,
			argv = None,
			kwargs
	)

Run application.

Parameters

argv	Optional argument list to override command-line arguments.
kwargs	Optional keyword argument list.

Returns

Exit code.

Definition at line 668 of file laelaps_diag.py.

References laelaps_diag.application.getOptions(), laelaps_diag.DiagMotors.kwargs, laelaps_diag.DiagToFs.kwargs, laelaps_diag.DiagImu.kwargs, laelaps_diag.DiagWatchdog.kwargs, and laelaps_diag.application.kwargs.

  def run(self, argv=None, **kwargs):
  
    # parse command-line options and arguments
    try:
      self.kwargs = self.getOptions(argv, **kwargs)
    except usage, e:
      print e.msg
      return 128

    passCnt = 0
    diagCnt = 0
    for diag in self.kwargs['diags']:
      try:
        Diagnostics.index(diag)
      except ValueError:
        print "%s: Unknown diagnostic - ignoring" % (diag)
        continue
      diagCnt += 1
      if diag == 'motors':
        diag = DiagMotors(self.kwargs)
      elif diag == 'tofs':
        diag = DiagToFs(self.kwargs)
      elif diag == 'imu':
        diag = DiagImu(self.kwargs)
      elif diag == 'watchdog':
        diag = DiagWatchdog(self.kwargs)
      passCnt += diag.run()
      
    print
    print "      ~~~"
    print "%d/%d diagnostics passed." % (passCnt, diagCnt)
    print

    return passCnt


# ------------------------------------------------------------------------------
# main
# ------------------------------------------------------------------------------

---

The documentation for this class was generated from the following file:

• sw/scripts/laelaps_diag.py