pantilt_console.window Class Reference

Window class supporting application. More...

Inheritance diagram for pantilt_console.window:

Public Member Functions
def	__init__ (self, master=None, cnf={}, kw)
	Constructor. More...
def	initData (self, kw)
	Initialize class state data. More...
def	createWidgets (self)
	Create gui widgets with supporting data and show.
def	createHeading (self)
	Create top gui heading.
def	createLeftButtons (self)
	Create gui left hand side buttons.
def	createCenterPanel (self)
	Create gui center panel.
def	createRightButtons (self)
	Create gui right hand side buttons.
def	createStatusBar (self)
	Create gui multi-line status bar at bottom of gui window.
def	createButton (self, parent, text, imagefile, command, fg='black')
	Create button. More...
def	clearSelect (self)
	Clear all select checkboxes.
def	cbSelect (self)
	Checkbox change state callback.
def	cbStartServices (self)
	Start selected services callback.
def	cbStopServices (self)
	Stop selected services callback.
def	cbRestartServices (self)
	Restart selected services callback.
def	cbRefreshStatus (self)
	Refresh services status callback.
def	cbSave (self)
	Save new settings callback.
def	destroy (self)
	Destroy window callback.
def	showSbInfo (self, text)
	Show information text on status bar. More...
def	showSbError (self, text)
	Show error text on status bar. More...
def	showSbOk (self, text)
	Show ok text on status bar. More...
def	showSbResult (self, text, success)
	Show operation result on status bar. More...
def	showSbStatus (self, text, status)
	Show service status result on status bar. More...
def	setStatus (self, service, status)
	Set service status field. More...
def	autoRefresh (self)
def	refresh (self)
	Refresh status of all services.
def	execStart (self, service)
	Execute 'service <service> start' subprocess. More...
def	execStop (self, service)
	Execute 'service <service> stop' subprocess. More...
def	execRestart (self, service)
	Execute 'service <service> restart' subprocess. More...
def	execStatus (self, service)
	Execute 'service <service> status' subprocess. More...

Public Attributes
	m_imageLoader
	m_debug
	m_icons
	m_wBttn
	m_svcKeys
	m_svcDesc
	m_lock
	m_service
	m_wScrollBar
	m_wStatusBar

Detailed Description

Window class supporting application.

Definition at line 98 of file pantilt_console.py.

Constructor & Destructor Documentation

def pantilt_console.window.__init__	(		self,
			master = None,
			cnf = {},
			kw
	)

Constructor.

Parameters

master	Window parent master widget.
cnf	Configuration dictionary.
kw	Keyword options.

Definition at line 106 of file pantilt_console.py.

References pantilt_console.window.autoRefresh(), pantilt_console.window.createWidgets(), pantilt_console.window.initData(), pantilt_console.window.m_icons, and pantilt_console.window.m_imageLoader.

  def __init__(self, master=None, cnf={}, **kw):
    # intialize window data
    kw = self.initData(kw)

    self.m_imageLoader = ImageLoader(py_pkg='Laelaps.images',
                                      image_paths=imagePath)

    Frame.__init__(self, master=master, cnf=cnf, **kw)
    self.master.title("Laelaps Init.d Console")

    self.m_icons['app_icon'] = \
                    self.m_imageLoader.loadImage("icons/LaelapsInitIcon.png")
    if self.m_icons['app_icon'] is not None:
      self.master.tk.call('wm', 'iconphoto', self.master._w,
        self.m_icons['app_icon'])

    # craete and show widgets
    self.createWidgets()

    self.grid(row=0, column=0, padx=5, pady=5)

    self.after(100, self.autoRefresh)

Member Function Documentation

def pantilt_console.window.createButton	(		self,
			parent,
			text,
			imagefile,
			command,
			fg = 'black'
	)

Create button.

Parameters

parent	Parent widget.
text	Button text.
imagefile	Image file name. None for no image.
command	Callback for button push.
fg	Foreground text color.

Returns

Button widget.

Definition at line 382 of file pantilt_console.py.

References pantilt_console.window.m_icons, and pantilt_console.window.m_wBttn.

Referenced by pantilt_console.window.createLeftButtons(), and pantilt_console.window.createRightButtons().

  def createButton(self, parent, text, imagefile, command, fg='black'):
    key = str.lower(text.replace("\n", "_"))
    self.m_icons[key] = self.m_imageLoader.loadImage(imagefile)
    w = Button(parent)
    w['text']     = text
    if self.m_icons[key]:
      w['image']    = self.m_icons[key]
      w['compound'] = LEFT
      w['padx']     = 0
      w['pady']     = 0
      w['anchor']   = W
      w['width']    = 105
    else:
      w['anchor']   = CENTER
      w['width']    = 10
    w['fg']       = fg
    w['command']  = command
    self.m_wBttn[key] = w
    return self.m_wBttn[key]

def pantilt_console.window.execRestart	(		self,
			service
	)

Execute 'service <service> restart' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 647 of file pantilt_console.py.

Referenced by pantilt_console.window.cbRestartServices().

  def execRestart(self, service):
    s = ''
    hasLock = self.m_lock.acquire()
    try:
      s = subprocess.check_output(["service", service, "restart"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      self.m_lock.release()
      return False
    self.m_lock.release()
    if reDoneDone.search(s):
      return True
    elif reFailDone.search(s):
      return True
    else:
      return False

def pantilt_console.window.execStart	(		self,
			service
	)

Execute 'service <service> start' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 603 of file pantilt_console.py.

Referenced by pantilt_console.window.cbStartServices().

  def execStart(self, service):
    s = ''
    hasLock = self.m_lock.acquire()
    try:
      s = subprocess.check_output(["service", service, "start"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      self.m_lock.release()
      return False
    self.m_lock.release()
    if reFail.search(s):
      return False
    else:
      return True

def pantilt_console.window.execStatus	(		self,
			service
	)

Execute 'service <service> status' subprocess.

Parameters

servcie

Service (key).

Returns

Service status. One of: 'running' 'stopped' 'unknown'

Definition at line 671 of file pantilt_console.py.

Referenced by pantilt_console.window.cbRefreshStatus(), and pantilt_console.window.refresh().

  def execStatus(self, service):
    s = ''
    hasLock = self.m_lock.acquire()
    try:
      s = subprocess.check_output(["service", service, "status"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      s = inst.output
    self.m_lock.release()
    if reRunning.search(s):
      return ('running', s)
    elif reNotRunning.search(s):
      return ('stopped', s)
    else:
      return ('unknown', s)


# ------------------------------------------------------------------------------
# Exception Class usage
# ------------------------------------------------------------------------------

def pantilt_console.window.execStop	(		self,
			service
	)

Execute 'service <service> stop' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 625 of file pantilt_console.py.

Referenced by pantilt_console.window.cbStopServices().

  def execStop(self, service):
    s = ''
    hasLock = self.m_lock.acquire()
    try:
      s = subprocess.check_output(["service", service, "stop"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      self.m_lock.release()
      return False
    self.m_lock.release()
    if reFail.search(s):
      return False
    else:
      return True

def pantilt_console.window.initData	(		self,
			kw
	)

Initialize class state data.

Any keywords for this application specific window that are not supported by the Frame Tkinter class must be removed.

Parameters

kw	Keyword options.

Returns

Modified keywords sans this specific class.

Definition at line 139 of file pantilt_console.py.

References pantilt_console.window.m_debug, pantilt_console.window.m_icons, pantilt_console.window.m_lock, pantilt_console.window.m_svcDesc, pantilt_console.window.m_svcKeys, and pantilt_console.window.m_wBttn.

Referenced by pantilt_console.window.__init__().

  def initData(self, kw):
    self.m_debug          = False # default debug level
    self.m_icons          = {}    # must keep loaded icons referenced
    self.m_wBttn          = {}    # button widgets
    self.m_svcKeys        = [
      'laelaps_bsproxy',  'laelaps_roscore',  'laelaps_control',
      'laelaps_xbox',     'laelaps_teleop']
    self.m_svcDesc        = {
        'laelaps_bsproxy':  'BotSense Proxy Server',
        'laelaps_roscore':  'ROS Master, Parameter Server, rosout logging node',
        'laelaps_control':  'Laelaps Control ROS node',
        'laelaps_xbox':     'HID Xbox360 daemon / ROS node',
        'laelaps_teleop':   'Laelaps Teleoperation ROS node'}
    self.m_lock = threading.Lock()

    if kw.has_key('debug'):
      self.m_debug = kw['debug']
      del kw['debug']

    # variables only used for debugging
    if self.m_debug:
      pass

    return kw

def pantilt_console.window.setStatus	(		self,
			service,
			status
	)

Set service status field.

Parameters

servcie	Service (key).
status	Service status. One of: 'running' 'stopped' 'unknown'

Definition at line 580 of file pantilt_console.py.

References pantilt_console.window.autoRefresh(), pantilt_console.window.m_service, and pantilt_console.window.refresh().

Referenced by pantilt_console.window.cbRefreshStatus(), and pantilt_console.window.refresh().

  def setStatus(self, service, status):
    self.m_service[service]['status'].set(status)
    self.m_service[service]['wstatus']['fg'] = statusText[status]

def pantilt_console.window.showSbError	(		self,
			text
	)

Show error text on status bar.

Parameters

text	Error text string.

Definition at line 516 of file pantilt_console.py.

References pantilt_console.window.m_wStatusBar.

Referenced by pantilt_console.window.showSbResult(), and pantilt_console.window.showSbStatus().

  def showSbError(self, text):
    self.m_wStatusBar["state"] = "normal"
    idx0 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.insert(END, text)
    idx1 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.tag_add("err", idx0, idx1)
    self.m_wStatusBar.tag_config("err", foreground=fgColors['error'])
    self.m_wStatusBar.see(END)
    self.m_wStatusBar["state"] = "disabled"

def pantilt_console.window.showSbInfo	(		self,
			text
	)

Show information text on status bar.

Parameters

text	Info text string.

Definition at line 501 of file pantilt_console.py.

References pantilt_console.window.m_wStatusBar.

Referenced by pantilt_console.window.cbRefreshStatus(), pantilt_console.window.cbRestartServices(), pantilt_console.window.cbSave(), pantilt_console.window.cbStartServices(), pantilt_console.window.cbStopServices(), and pantilt_console.window.showSbStatus().

  def showSbInfo(self, text):
    self.m_wStatusBar["state"] = "normal"
    idx0 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.insert(END, text)
    idx1 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.tag_add("norm", idx0, idx1)
    self.m_wStatusBar.tag_config("norm", foreground=fgColors['normal'])
    self.m_wStatusBar.see(END)
    self.m_wStatusBar["state"] = "disabled"

def pantilt_console.window.showSbOk	(		self,
			text
	)

Show ok text on status bar.

Parameters

text	Ok text string.

Definition at line 531 of file pantilt_console.py.

References pantilt_console.window.m_wStatusBar.

Referenced by pantilt_console.window.showSbResult(), and pantilt_console.window.showSbStatus().

  def showSbOk(self, text):
    self.m_wStatusBar["state"] = "normal"
    idx0 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.insert(END, text)
    idx1 = self.m_wStatusBar.index(INSERT)
    self.m_wStatusBar.tag_add("ok", idx0, idx1)
    self.m_wStatusBar.tag_config("ok", foreground=fgColors['ok'])
    self.m_wStatusBar.see(END)
    self.m_wStatusBar["state"] = "disabled"

def pantilt_console.window.showSbResult	(		self,
			text,
			success
	)

Show operation result on status bar.

Parameters

text	Prefix text already displayed on current status bar line.
success	Operation was [not] a success.

Definition at line 547 of file pantilt_console.py.

References pantilt_console.window.m_wStatusBar, pantilt_console.window.showSbError(), and pantilt_console.window.showSbOk().

Referenced by pantilt_console.window.cbRestartServices(), pantilt_console.window.cbStartServices(), and pantilt_console.window.cbStopServices().

  def showSbResult(self, text, success):
    n = self.m_wStatusBar['width'] - len(text)
    if success:
      rc = '[ok]'
      self.showSbOk("%*s\n" % (n, rc))
    else:
      rc = '[failed]'
      self.showSbError("%*s\n" % (n, rc))

def pantilt_console.window.showSbStatus	(		self,
			text,
			status
	)

Show service status result on status bar.

Parameters

text	Prefix text already displayed on current status bar line.
status	Service status. One of: 'running' 'stopped' 'unknown'

Definition at line 562 of file pantilt_console.py.

References pantilt_console.window.m_wStatusBar, pantilt_console.window.showSbError(), pantilt_console.window.showSbInfo(), and pantilt_console.window.showSbOk().

Referenced by pantilt_console.window.cbRefreshStatus().

  def showSbStatus(self, text, status):
    n = self.m_wStatusBar['width'] - len(text)
    if status == 'running':
      rc = '[running]'
      self.showSbOk("%*s\n" % (n, rc))
    elif status == 'stopped':
      rc = '[stopped]'
      self.showSbError("%*s\n" % (n, rc))
    else:
      rc = '[unknown]'
      self.showSbInfo("%*s\n" % (n, rc))

---

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

• sw/scripts/pantilt_console.py