plugin.telegram.BoswatchPlugin Class Reference

Public Member Functions
def	__init__ (self, config)
	Do not change anything here!
def	onLoad (self)
	Called by import of the plugin.
def	setup (self)
	Called before alarm Remove if not implemented.
def	fms (self, bwPacket)
	Called on FMS alarm.
def	pocsag (self, bwPacket)
	Called on POCSAG alarm.
def	zvei (self, bwPacket)
	Called on ZVEI alarm.
def	msg (self, bwPacket)
	Called on MSG packet.
def	teardown (self)
	Called after alarm Remove if not implemented.
def	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.
Public Member Functions inherited from plugin.pluginBase.PluginBase
def	__init__ (self, pluginName, config)
	init preload some needed locals and then call onLoad() directly
def	onLoad (self)
	Called by import of the plugin can be inherited.
def	setup (self)
	Called before alarm can be inherited.
def	fms (self, bwPacket)
	Called on FMS alarm can be inherited.
def	pocsag (self, bwPacket)
	Called on POCSAG alarm can be inherited.
def	zvei (self, bwPacket)
	Called on ZVEI alarm can be inherited.
def	msg (self, bwPacket)
	Called on MSG packet can be inherited.
def	teardown (self)
	Called after alarm can be inherited.
def	onUnload (self)
	Called on shutdown of boswatch can be inherited.
def	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
def	_cleanup (self)
	Cleanup routine calls onUnload() directly.
def	_run (self, bwPacket)
	start an complete running turn of an plugin.
def	_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__()

def 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()

def 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
 
        # Konfigurierbare Parameter mit Fallback-Defaults
        max_retries = self.config.get("max_retries")
        initial_delay = self.config.get("initial_delay")
        max_delay = self.config.get("max_delay")
 
        self.sender = TelegramSender(
            bot_token=bot_token,
            chat_ids=chat_ids,
            max_retries=max_retries,
            initial_delay=initial_delay,
            max_delay=max_delay
        )
 
        startup_message = self.config.get("startup_message")
        if startup_message and startup_message.strip():
            self.sender.send_message(startup_message)
 

setup()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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()

def 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