plugin.telegram.BoswatchPlugin Class Reference

Description of the Plugin. More...

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin.
	fms (self, bwPacket)
	Called on FMS alarm.
	pocsag (self, bwPacket)
	Called on POCSAG alarm.
	zvei (self, bwPacket)
	Called on ZVEI alarm.
	msg (self, bwPacket)
	Called on MSG packet.
Public Member Functions inherited from plugin.pluginBase.PluginBase
	setup (self)
	Called before alarm 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
	bot
Data Fields inherited from plugin.pluginBase.PluginBase
	config

Protected Member Functions
	_sendMessage (self, message)
	_sendLocation (self, lat, lon)
Protected Member Functions inherited from plugin.pluginBase.PluginBase
	_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.

Additional Inherited Members
Protected Attributes inherited from plugin.pluginBase.PluginBase
	_pluginName
	_bwPacket
	_sumTime
	_cumTime
	_setupTime
	_alarmTime
	_teardownTime
	_runCount
	_setupErrorCount
	_alarmErrorCount
	_teardownErrorCount
Static Protected Attributes inherited from plugin.pluginBase.PluginBase
list	_pluginsActive = []

Detailed Description

Description of the Plugin.

Constructor & Destructor Documentation

__init__()

plugin.telegram.BoswatchPlugin.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from plugin.pluginBase.PluginBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

onLoad()

plugin.telegram.BoswatchPlugin.onLoad

(

self

)

Called by import of the plugin.

Reimplemented from plugin.pluginBase.PluginBase.

    def onLoad(self):
        r"""!Called by import of the plugin"""
        if self.config.get("queue", default=True):
            q = mq.MessageQueue()
            request = Request(con_pool_size=8)
            self.bot = MQBot(token=self.config.get("botToken", default=""), request=request, mqueue=q)
            print('queue')
        else:
            self.bot = telegram.Bot(token=self.config.get("botToken"))
            print('normal')
 

fms()

plugin.telegram.BoswatchPlugin.fms	(		self,
			bwPacket
	)

Called on FMS alarm.

Parameters

bwPacket

bwPacket instance

Reimplemented from plugin.pluginBase.PluginBase.

    def fms(self, bwPacket):
        r"""!Called on FMS alarm
 
        @param bwPacket: bwPacket instance"""
        msg = self.parseWildcards(self.config.get("message_fms", default="{FMS}"))
        self._sendMessage(msg)
 

pocsag()

plugin.telegram.BoswatchPlugin.pocsag	(		self,
			bwPacket
	)

Called on POCSAG alarm.

Parameters

bwPacket

bwPacket instance

Reimplemented from plugin.pluginBase.PluginBase.

    def pocsag(self, bwPacket):
        r"""!Called on POCSAG alarm
 
        @param bwPacket: bwPacket instance"""
        msg = self.parseWildcards(self.config.get("message_pocsag", default="{RIC}({SRIC})\n{MSG}"))
        self._sendMessage(msg)
 
        if bwPacket.get("lat") is not None and bwPacket.get("lon") is not None:
            logging.debug("Found coordinates in packet")
            (lat, lon) = (bwPacket.get("lat"), bwPacket.get("lon"))
            self._sendLocation(lat, lon)
 

zvei()

plugin.telegram.BoswatchPlugin.zvei	(		self,
			bwPacket
	)

Called on ZVEI alarm.

Parameters

bwPacket

bwPacket instance

Reimplemented from plugin.pluginBase.PluginBase.

    def zvei(self, bwPacket):
        r"""!Called on ZVEI alarm
 
        @param bwPacket: bwPacket instance"""
        msg = self.parseWildcards(self.config.get("message_zvei", default="{TONE}"))
        self._sendMessage(msg)
 

msg()

plugin.telegram.BoswatchPlugin.msg	(		self,
			bwPacket
	)

Called on MSG packet.

Parameters

bwPacket

bwPacket instance

Reimplemented from plugin.pluginBase.PluginBase.

    def msg(self, bwPacket):
        r"""!Called on MSG packet
 
        @param bwPacket: bwPacket instance"""
        msg = self.parseWildcards(self.config.get("message_msg"))
        self._sendMessage(msg)
 

_sendMessage()

plugin.telegram.BoswatchPlugin._sendMessage (   self,   message  )

protected

    def _sendMessage(self, message):
        for chatId in self.config.get("chatIds", default=[]):
            try:
                # Send Message via Telegram
                logging.info("Sending message to " + chatId)
                self.bot.send_message(chat_id=chatId, text=message)
 
            except Unauthorized:
                logging.exception("Error while sending Telegram Message, please Check your api-key")
            except (TimedOut, NetworkError):
                logging.exception("Error while sending Telegram Message, please Check your connectivity")
            except (BadRequest, TelegramError):
                logging.exception("Error while sending Telegram Message")
            except Exception as e:
                logging.exception("Unknown Error while sending Telegram Message: " + str(type(e).__name__) + ": " + str(e))
 

_sendLocation()

plugin.telegram.BoswatchPlugin._sendLocation (   self,   lat,   lon  )

protected

    def _sendLocation(self, lat, lon):
        for chatId in self.config.get("chatIds", default=[]):
            try:
                # Send Location via Telegram
                if lat is not None and lon is not None:
                    logging.info("Sending location to " + chatId)
                    self.bot.sendLocation(chat_id=chatId, latitude=lat, longitude=lon)
 
            except Unauthorized:
                logging.exception("Error while sending Telegram Message, please Check your api-key")
            except (TimedOut, NetworkError):
                logging.exception("Error while sending Telegram Message, please Check your connectivity")
            except (BadRequest, TelegramError):
                logging.exception("Error while sending Telegram Message")
            except Exception as e:
                logging.exception("Unknown Error while sending Telegram Message: " + str(type(e).__name__) + ": " + str(e))

Field Documentation

bot

plugin.telegram.BoswatchPlugin.bot