Main plugin class. More...

Public Member Functions
	__init__ (self, pluginName, config)
	init preload some needed locals and then call onLoad() directly

	onLoad (self)
	Called by import of the plugin can be inherited.

	setup (self)
	Called before alarm can be inherited.

	fms (self, bwPacket)
	Called on FMS alarm can be inherited.

	pocsag (self, bwPacket)
	Called on POCSAG alarm can be inherited.

	zvei (self, bwPacket)
	Called on ZVEI alarm can be inherited.

	msg (self, bwPacket)
	Called on MSG packet can be inherited.

	teardown (self)
	Called after alarm can be inherited.

	onUnload (self)
	Called on shutdown of boswatch can be inherited.

	parseWildcards (self, msg)
	Return the message with parsed wildcards.

Data Fields
	config

Protected Member Functions
	_cleanup (self)
	Cleanup routine calls onUnload() directly.

	_run (self, bwPacket)
	start an complete running turn of an plugin.

	_getStatistics (self)
	Returns statistical information's from last plugin run.

Protected Attributes
	_pluginName

	_bwPacket

	_sumTime

	_cumTime

	_setupTime

	_alarmTime

	_teardownTime

	_runCount

	_setupErrorCount

	_alarmErrorCount

	_teardownErrorCount

Static Protected Attributes
list	_pluginsActive = []

Detailed Description

Main plugin class.

Constructor & Destructor Documentation

◆ init()

plugin.pluginBase.PluginBase.__init__	(	self,
		pluginName,
		config
	)

init preload some needed locals and then call onLoad() directly

Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def __init__(self, pluginName, config):
        r"""!init preload some needed locals and then call onLoad() directly"""
        self._pluginName = pluginName
        self.config = config
        self._pluginsActive.append(self)
 
        # to save the packet while alarm is running for other functions
        self._bwPacket = None
 
        # for time counting
        self._sumTime = 0
        self._cumTime = 0
        self._setupTime = 0
        self._alarmTime = 0
        self._teardownTime = 0
 
        # for statistics
        self._runCount = 0
        self._setupErrorCount = 0
        self._alarmErrorCount = 0
        self._teardownErrorCount = 0
 
        logging.debug("[%s] onLoad()", pluginName)
        self.onLoad()
 

Member Function Documentation

◆ _cleanup()

plugin.pluginBase.PluginBase._cleanup ( self )

protected

Cleanup routine calls onUnload() directly.

    def _cleanup(self):
        r"""!Cleanup routine calls onUnload() directly"""
        logging.debug("[%s] onUnload()", self._pluginName)
        self._pluginsActive.remove(self)
        self.onUnload()
 

◆ _run()

plugin.pluginBase.PluginBase._run	(	self,
		bwPacket
	)

protected

start an complete running turn of an plugin.

Calls setup(), alarm() and teardown() in this order. The alarm() method serves the BOSWatch packet to the plugin.

Parameters

bwPacket A BOSWatch packet instance

    def _run(self, bwPacket):
        r"""!start an complete running turn of an plugin.
        Calls setup(), alarm() and teardown() in this order.
        The alarm() method serves the BOSWatch packet to the plugin.
 
        @param bwPacket: A BOSWatch packet instance"""
        self._runCount += 1
        logging.debug("[%s] run #%d", self._pluginName, self._runCount)
 
        self._bwPacket = bwPacket
 
        tmpTime = time.time()
        try:
            logging.debug("[%s] setup()", self._pluginName)
            self.setup()
        except:
            self._setupErrorCount += 1
            logging.exception("[%s] error in setup()", self._pluginName)
 
        self._setupTime = time.time() - tmpTime
        tmpTime = time.time()
        try:
 
            if bwPacket.get("mode") == "fms":
                logging.debug("[%s] fms()", self._pluginName)
                self.fms(bwPacket)
            if bwPacket.get("mode") == "pocsag":
                logging.debug("[%s] pocsag()", self._pluginName)
                self.pocsag(bwPacket)
            if bwPacket.get("mode") == "zvei":
                logging.debug("[%s] zvei()", self._pluginName)
                self.zvei(bwPacket)
            if bwPacket.get("mode") == "msg":
                logging.debug("[%s] msg()", self._pluginName)
                self.msg(bwPacket)
        except:
            self._alarmErrorCount += 1
            logging.exception("[%s] alarm error", self._pluginName)
 
        self._alarmTime = time.time() - tmpTime
        tmpTime = time.time()
        try:
            logging.debug("[%s] teardown()", self._pluginName)
            self.teardown()
        except:
            self._teardownErrorCount += 1
            logging.exception("[%s] error in teardown()", self._pluginName)
 
        self._teardownTime = time.time() - tmpTime
        self._sumTime = self._setupTime + self._alarmTime + self._teardownTime
        self._cumTime += self._sumTime
 
        self._bwPacket = None
 
        logging.debug("[%s] took %0.3f seconds", self._pluginName, self._sumTime)
        # logging.debug("- setup:    %0.2f sec.", self._setupTime)
        # logging.debug("- alarm:    %0.2f sec.", self._alarmTime)
        # logging.debug("- teardown: %0.2f sec.", self._teardownTime)
 
        return None
 

◆ _getStatistics()

plugin.pluginBase.PluginBase._getStatistics ( self )

protected

Returns statistical information's from last plugin run.

Returns: Statistics as pyton dict

    def _getStatistics(self):
        r"""!Returns statistical information's from last plugin run
 
        @return Statistics as pyton dict"""
        stats = {"type": "plugin",
                 "runCount": self._runCount,
                 "sumTime": self._sumTime,
                 "cumTime": self._cumTime,
                 "setupTime": self._setupTime,
                 "alarmTime": self._alarmTime,
                 "teardownTime": self._teardownTime,
                 "setupErrorCount": self._setupErrorCount,
                 "alarmErrorCount": self._alarmErrorCount,
                 "teardownErrorCount": self._teardownErrorCount}
        return stats
 

◆ onLoad()

plugin.pluginBase.PluginBase.onLoad ( self )

Called by import of the plugin can be inherited.

Reimplemented in plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def onLoad(self):
        r"""!Called by import of the plugin
        can be inherited"""
        pass
 

◆ setup()

plugin.pluginBase.PluginBase.setup ( self )

Called before alarm can be inherited.

Reimplemented in plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def setup(self):
        r"""!Called before alarm
        can be inherited"""
        pass
 

◆ fms()

plugin.pluginBase.PluginBase.fms	(	self,
		bwPacket
	)

Called on FMS alarm can be inherited.

Parameters

bwPacket bwPacket instance

Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def fms(self, bwPacket):
        r"""!Called on FMS alarm
        can be inherited
 
        @param bwPacket: bwPacket instance"""
        logging.warning("ZVEI not implemented in %s", self._pluginName)
 

◆ pocsag()

plugin.pluginBase.PluginBase.pocsag	(	self,
		bwPacket
	)

Called on POCSAG alarm can be inherited.

Parameters

bwPacket bwPacket instance

Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def pocsag(self, bwPacket):
        r"""!Called on POCSAG alarm
        can be inherited
 
        @param bwPacket: bwPacket instance"""
        logging.warning("POCSAG not implemented in %s", self._pluginName)
 

◆ zvei()

plugin.pluginBase.PluginBase.zvei	(	self,
		bwPacket
	)

Called on ZVEI alarm can be inherited.

Parameters

bwPacket bwPacket instance

Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def zvei(self, bwPacket):
        r"""!Called on ZVEI alarm
        can be inherited
 
        @param bwPacket: bwPacket instance"""
        logging.warning("ZVEI not implemented in %s", self._pluginName)
 

◆ msg()

plugin.pluginBase.PluginBase.msg	(	self,
		bwPacket
	)

Called on MSG packet can be inherited.

Parameters

bwPacket bwPacket instance

Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def msg(self, bwPacket):
        r"""!Called on MSG packet
        can be inherited
 
        @param bwPacket: bwPacket instance"""
        logging.warning("MSG not implemented in %s", self._pluginName)
 

◆ teardown()

plugin.pluginBase.PluginBase.teardown ( self )

Called after alarm can be inherited.

Reimplemented in plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def teardown(self):
        r"""!Called after alarm
        can be inherited"""
        pass
 

◆ onUnload()

plugin.pluginBase.PluginBase.onUnload ( self )

Called on shutdown of boswatch can be inherited.

Reimplemented in plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.

    def onUnload(self):
        r"""!Called on shutdown of boswatch
        can be inherited"""
        pass
 

◆ parseWildcards()

plugin.pluginBase.PluginBase.parseWildcards	(	self,
		msg
	)

Return the message with parsed wildcards.

    def parseWildcards(self, msg):
        r"""!Return the message with parsed wildcards"""
        if self._bwPacket is None:
            logging.warning("wildcard replacing not allowed - no bwPacket set")
            return msg
        return wildcard.replaceWildcards(msg, self._bwPacket)

Field Documentation

◆ _pluginsActive

list plugin.pluginBase.PluginBase._pluginsActive = []

staticprotected

◆ _pluginName

plugin.pluginBase.PluginBase._pluginName

protected

◆ config

plugin.pluginBase.PluginBase.config

◆ _bwPacket

plugin.pluginBase.PluginBase._bwPacket

protected

◆ _sumTime

plugin.pluginBase.PluginBase._sumTime

protected

◆ _cumTime

plugin.pluginBase.PluginBase._cumTime

protected

◆ _setupTime

plugin.pluginBase.PluginBase._setupTime

protected

◆ _alarmTime

plugin.pluginBase.PluginBase._alarmTime

protected

◆ _teardownTime

plugin.pluginBase.PluginBase._teardownTime

protected

◆ _runCount

plugin.pluginBase.PluginBase._runCount

protected

◆ _setupErrorCount

plugin.pluginBase.PluginBase._setupErrorCount

protected

◆ _alarmErrorCount

plugin.pluginBase.PluginBase._alarmErrorCount

protected

◆ _teardownErrorCount

plugin.pluginBase.PluginBase._teardownErrorCount

protected

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _cleanup()

◆ _run()

◆ _getStatistics()

◆ onLoad()

◆ setup()

◆ fms()

◆ pocsag()

◆ zvei()

◆ msg()

◆ teardown()

◆ onUnload()

◆ parseWildcards()

Field Documentation

◆ _pluginsActive

◆ _pluginName

◆ config

◆ _bwPacket

◆ _sumTime

◆ _cumTime

◆ _setupTime

◆ _alarmTime

◆ _teardownTime

◆ _runCount

◆ _setupErrorCount

◆ _alarmErrorCount

◆ _teardownErrorCount

◆ init()