hek_init.window Class Reference

Window class supporting application. More...

Inheritance diagram for hek_init.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_osdist
	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 135 of file hek_init.d.py.

Constructor & Destructor Documentation

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

Constructor.

Parameters

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

Definition at line 143 of file hek_init.d.py.

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

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

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

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

    self.m_icons['app_icon'] = \
                    self.m_imageLoader.loadImage("icons/HekaterosInitIcon.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 hek_init.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 420 of file hek_init.d.py.

References hek_init.window.m_icons, and hek_init.window.m_wBttn.

Referenced by hek_init.window.createLeftButtons(), and hek_init.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 hek_init.window.execRestart	(		self,
			service
	)

Execute 'service <service> restart' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 691 of file hek_init.d.py.

References hek_init.window.m_osdist.

Referenced by hek_init.window.cbRestartServices().

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

def hek_init.window.execStart	(		self,
			service
	)

Execute 'service <service> start' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 641 of file hek_init.d.py.

References hek_init.window.m_osdist.

Referenced by hek_init.window.cbStartServices().

  def execStart(self, service):
    rsp = ''
    hasLock = self.m_lock.acquire()
    try:
      rsp = subprocess.check_output(["service", service, "start"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      self.m_lock.release()
      return False
    self.m_lock.release()
    if os_ver_ge(self.m_osdist[1], 15.04):
      return True  # no output 
    else:
      if reFail.search(rsp):
        return False
      else:
        return True

def hek_init.window.execStatus	(		self,
			service
	)

Execute 'service <service> status' subprocess.

On Ubuntu 16.04+ the output to 'service <service> status' changed. It does call the init.d script, but rather uses the systemd calls. These output muliple lines of info. So this script now supports the new interace but is also backwards capatible with Ubuntu 14.04- releases (hopefully).

Parameters

servcie

Service (key).

Returns

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

Definition at line 723 of file hek_init.d.py.

References hek_init.window.m_osdist.

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

  def execStatus(self, service):
    rsp = ''
    hasLock = self.m_lock.acquire()
    try:
      rsp = subprocess.check_output(["service", service, "status"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      rsp = inst.output
    self.m_lock.release()

    if os_ver_ge(self.m_osdist[1], 15.04):
      rsp = rsp.split("\n")
      for line in rsp:
        if reActive.search(line):
          return ('running', line)
        elif reInactive.search(line):
          return ('stopped', line)
      return ('unknown', "")
    else:
      if reRunning.search(rsp):
        return ('running', rsp)
      elif reNotRunning.search(rsp):
        return ('stopped', rsp)
      else:
        return ('unknown', rsp)


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

def hek_init.window.execStop	(		self,
			service
	)

Execute 'service <service> stop' subprocess.

Parameters

servcie

Service (key).

Returns

Returns True on success, False on failure.

Definition at line 666 of file hek_init.d.py.

References hek_init.window.m_osdist.

Referenced by hek_init.window.cbStopServices().

  def execStop(self, service):
    rsp = ''
    hasLock = self.m_lock.acquire()
    try:
      rsp = subprocess.check_output(["service", service, "stop"],
                                  stderr=subprocess.STDOUT)
    except subprocess.CalledProcessError, inst:
      self.m_lock.release()
      return False
    self.m_lock.release()
    if os_ver_ge(self.m_osdist[1], 15.04):
      return True  # no output 
    else:
      if reFail.search(rsp):
        return False
      else:
        return True

def hek_init.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 176 of file hek_init.d.py.

References hek_init.window.m_debug, hek_init.window.m_icons, hek_init.window.m_lock, hek_init.window.m_osdist, hek_init.window.m_svcDesc, hek_init.window.m_svcKeys, and hek_init.window.m_wBttn.

Referenced by hek_init.window.__init__(), and dynacfg.window.__init__().

  def initData(self, kw):
    self.m_osdist         = os_distribution()
    self.m_debug          = False # default debug level
    self.m_icons          = {}    # must keep loaded icons referenced
    self.m_wBttn          = {}    # button widgets
    self.m_svcKeys        = [
      'hek_bsproxy',  'hek_roscore',  'hek_control',
      'hek_xbox',     'hek_teleop']
    self.m_svcDesc        = {
        'hek_bsproxy':  'BotSense Proxy Server',
        'hek_roscore':  'ROS Master, Parameter Server, rosout logging node',
        'hek_control':  'Hekateros Control ROS node',
        'hek_xbox':     'HID Xbox360 daemon / ROS node',
        'hek_teleop':   'Hekateros 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 hek_init.window.setStatus	(		self,
			service,
			status
	)

Set service status field.

Parameters

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

Definition at line 618 of file hek_init.d.py.

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

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

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

def hek_init.window.showSbError	(		self,
			text
	)

Show error text on status bar.

Parameters

text	Error text string.

Definition at line 554 of file hek_init.d.py.

References hek_init.window.m_wStatusBar.

Referenced by hek_init.window.showSbResult(), and hek_init.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 hek_init.window.showSbInfo	(		self,
			text
	)

Show information text on status bar.

Parameters

text	Info text string.

Definition at line 539 of file hek_init.d.py.

References hek_init.window.m_wStatusBar.

Referenced by hek_init.window.cbRefreshStatus(), hek_init.window.cbRestartServices(), hek_init.window.cbSave(), hek_init.window.cbStartServices(), hek_init.window.cbStopServices(), and hek_init.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 hek_init.window.showSbOk	(		self,
			text
	)

Show ok text on status bar.

Parameters

text	Ok text string.

Definition at line 569 of file hek_init.d.py.

References hek_init.window.m_wStatusBar.

Referenced by hek_init.window.showSbResult(), and hek_init.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 hek_init.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 585 of file hek_init.d.py.

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

Referenced by hek_init.window.cbRestartServices(), hek_init.window.cbStartServices(), and hek_init.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 hek_init.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 600 of file hek_init.d.py.

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

Referenced by hek_init.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/hek_init.d.py