plugin.telegram.BoswatchPlugin Class Reference

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin.
	setup (self)
	Called before alarm Remove if not implemented.
	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.
	teardown (self)
	Called after alarm Remove if not implemented.
	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.
Public Member Functions inherited from plugin.pluginBase.PluginBase
	parseWildcards (self, msg)
	Return the message with parsed wildcards.

Data Fields
	sender
Data Fields inherited from plugin.pluginBase.PluginBase
	config

Additional Inherited Members
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.
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 = []

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"""
        bot_token = self.config.get("botToken")
        chat_ids = self.config.get("chatIds", default=[])
 
        if not bot_token or not chat_ids:
            logger.error("botToken oder chatIds fehlen in der Konfiguration!")
            return
 
        # configurable parameters with fallback defaults
        max_retries = self.config.get("max_retries")
        initial_delay = self.config.get("initial_delay")
        max_delay = self.config.get("max_delay")
        parse_mode = self.config.get("parse_mode")
 
        self.sender = TelegramSender(
            bot_token=bot_token,
            chat_ids=chat_ids,
            max_retries=max_retries,
            initial_delay=initial_delay,
            max_delay=max_delay,
            parse_mode=parse_mode
        )
 
        startup_message = self.config.get("startup_message")
        if startup_message and startup_message.strip():
            self.sender.send_message(startup_message)
 

setup()

plugin.telegram.BoswatchPlugin.setup

(

self

)

Called before alarm Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def setup(self):
        r"""!Called before alarm
        Remove if not implemented"""
        pass
 

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.sender.send_message(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.sender.send_message(msg)
 
        if bwPacket.get("lat") is not None and bwPacket.get("lon") is not None:
            lat, lon = bwPacket.get("lat"), bwPacket.get("lon")
            logger.debug("Koordinaten gefunden – sende Standort.")
            self.sender.send_location(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.sender.send_message(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.sender.send_message(msg)
 

teardown()

plugin.telegram.BoswatchPlugin.teardown

(

self

)

Called after alarm Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def teardown(self):
        r"""!Called after alarm
        Remove if not implemented"""
        pass
 

onUnload()

plugin.telegram.BoswatchPlugin.onUnload

(

self

)

Called by destruction of the plugin Remove if not implemented.

Reimplemented from plugin.pluginBase.PluginBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin
        Remove if not implemented"""
        pass

Field Documentation

sender

plugin.telegram.BoswatchPlugin.sender