plugin.mqtt.BoswatchPlugin Class Reference

Publishes BOSWatch alarms as JSON payload via MQTT. More...

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

Data Fields
	brokerAddress
	brokerPort
	topicTemplate
	clientId
	username
	password
	qos
	retain
	keepalive
	statusTopic
	queueSize
	maxRetries
	initialDelay
	maxDelay
	sender
Data Fields inherited from plugin.pluginBase.PluginBase
	config

Protected Member Functions
	_ensure_sender (self)
	Ensures that a MqttSender instance exists - checking-with-hasattr pattern analogous to telegram.py's _ensure_sender()
	_publish (self, bwPacket)
	Serializes the complete bwPacket to JSON and enqueues it with the sender.
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.

Static Protected Member Functions
	_json_serializer (obj)
	Fail-safe JSON serializer for non-primitive data types.
	_packet_to_dict (bwPacket)
	Extracts the complete content of the bwPacket object as a dict.

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

Publishes BOSWatch alarms as JSON payload via MQTT.

Constructor & Destructor Documentation

__init__()

plugin.mqtt.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.mqtt.BoswatchPlugin.onLoad

(

self

)

Called by import of the plugin.

Reimplemented from plugin.pluginBase.PluginBase.

    def onLoad(self):
        r"""!Called by import of the plugin"""
        self.brokerAddress = self.config.get("brokerAddress")
        self.brokerPort = int(self.config.get("brokerPort", default=1883))
        self.topicTemplate = self.config.get("topic", default="boswatch/alarm")
        self.clientId = self.config.get("clientId", default="boswatch")
        self.username = self.config.get("username", default=None)
        self.password = self.config.get("password", default=None)
        self.qos = int(self.config.get("qos", default=0))
        self.retain = bool(self.config.get("retain", default=False))
        self.keepalive = int(self.config.get("keepalive", default=60))
        self.statusTopic = self.config.get("statusTopic", default=None)
        self.queueSize = int(self.config.get("queueSize", default=200))
        self.maxRetries = int(self.config.get("maxRetries", default=5))
        self.initialDelay = int(self.config.get("initialDelay", default=2))
        self.maxDelay = int(self.config.get("maxDelay", default=60))
 
        if self.qos not in (0, 1, 2):
            logging.warning("MQTT Plugin: invalid qos value '%s' - using 0", self.qos)
            self.qos = 0
 
        self.sender = None
        self._ensure_sender()
 

setup()

plugin.mqtt.BoswatchPlugin.setup

(

self

)

Called before alarm - recreates the sender if needed (self-healing)

Reimplemented from plugin.pluginBase.PluginBase.

    def setup(self):
        r"""!Called before alarm - recreates the sender if needed (self-healing)"""
        self._ensure_sender()
 

fms()

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

Called on FMS alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def fms(self, bwPacket):
        r"""!Called on FMS alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._publish(bwPacket)
 

pocsag()

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

Called on POCSAG alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def pocsag(self, bwPacket):
        r"""!Called on POCSAG alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._publish(bwPacket)
 

zvei()

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

Called on ZVEI alarm.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def zvei(self, bwPacket):
        r"""!Called on ZVEI alarm
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._publish(bwPacket)
 

msg()

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

Called on MSG packet.

Parameters

bwPacket

bwPacket instance Remove if not implemented

Reimplemented from plugin.pluginBase.PluginBase.

    def msg(self, bwPacket):
        r"""!Called on MSG packet
 
        @param bwPacket: bwPacket instance
        Remove if not implemented"""
        self._publish(bwPacket)
 

onUnload()

plugin.mqtt.BoswatchPlugin.onUnload

(

self

)

Called by destruction of the plugin.

Reimplemented from plugin.pluginBase.PluginBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin"""
        if self.sender is not None:
            self.sender.shutdown()
 

_ensure_sender()

plugin.mqtt.BoswatchPlugin._ensure_sender (   self )

protected

Ensures that a MqttSender instance exists - checking-with-hasattr pattern analogous to telegram.py's _ensure_sender()

    def _ensure_sender(self):
        r"""!Ensures that a MqttSender instance exists - checking-with-hasattr pattern
        analogous to telegram.py's _ensure_sender()"""
        if self.sender is not None and self.sender.is_alive():
            return
 
        if not self.brokerAddress:
            logging.error("MQTT Plugin: 'brokerAddress' not configured - plugin will not send messages.")
            return
 
        try:
            self.sender = MqttSender(
                broker_address=self.brokerAddress,
                broker_port=self.brokerPort,
                client_id=self.clientId,
                username=self.username,
                password=self.password,
                keepalive=self.keepalive,
                qos=self.qos,
                retain=self.retain,
                status_topic=self.statusTopic,
                queue_size=self.queueSize,
                max_retries=self.maxRetries,
                initial_delay=self.initialDelay,
                max_delay=self.maxDelay
            )
            logging.debug("MQTT Plugin: MqttSender initialized")
        except Exception as e:
            logging.error("MQTT Plugin: sender could not be initialized: %s", e)
            self.sender = None
 

_publish()

plugin.mqtt.BoswatchPlugin._publish (   self,   bwPacket  )

protected

Serializes the complete bwPacket to JSON and enqueues it with the sender.

Parameters

bwPacket

bwPacket instance

    def _publish(self, bwPacket):
        r"""!Serializes the complete bwPacket to JSON and enqueues it with the sender
 
        @param bwPacket: bwPacket instance"""
        if self.sender is None:
            logging.warning("MQTT Plugin not configured - packet dropped")
            return
 
        payload = self._packet_to_dict(bwPacket)
        topic = self.parseWildcards(self.topicTemplate)
 
        try:
            json_payload = json.dumps(payload, default=self._json_serializer, ensure_ascii=False)
        except Exception as e:
            logging.error("MQTT Plugin: error during JSON serialization: %s", e)
            return
 
        self.sender.enqueue(topic, json_payload)
 

_json_serializer()

plugin.mqtt.BoswatchPlugin._json_serializer (   obj )

staticprotected

Fail-safe JSON serializer for non-primitive data types.

Packet.set() currently only ever stores strings, but this fallback defensively covers the case that a future module (e.g. a custom extension) writes an exotic object into a field - so a single unexpected data type cannot crash the whole plugin.

Parameters

obj	the object to serialize

Returns

: JSON-compatible representation

    def _json_serializer(obj):
        r"""!Fail-safe JSON serializer for non-primitive data types.
 
        Packet.set() currently only ever stores strings, but this fallback
        defensively covers the case that a future module (e.g. a custom
        extension) writes an exotic object into a field - so a single
        unexpected data type cannot crash the whole plugin.
 
        @param obj: the object to serialize
        @return: JSON-compatible representation"""
        if isinstance(obj, (datetime.date, datetime.datetime)):
            return obj.isoformat()
        if isinstance(obj, bytes):
            return obj.decode("utf-8", errors="replace")
        if isinstance(obj, set):
            return list(obj)
        try:
            return str(obj)
        except Exception:
            return repr(obj)
 

_packet_to_dict()

plugin.mqtt.BoswatchPlugin._packet_to_dict (   bwPacket )

staticprotected

Extracts the complete content of the bwPacket object as a dict.

Analogous to the approach in module/packetDump.py: instead of picking individual fields, the entire internal state of the packet is taken over, so fields added by other modules (Descriptor, Multicast, Geocoding, ...) automatically end up in the MQTT payload.

Parameters

bwPacket

bwPacket instance

Returns

: dict with all fields of the packet

    def _packet_to_dict(bwPacket):
        r"""!Extracts the complete content of the bwPacket object as a dict.
 
        Analogous to the approach in module/packetDump.py: instead of
        picking individual fields, the entire internal state of the packet
        is taken over, so fields added by other modules (Descriptor,
        Multicast, Geocoding, ...) automatically end up in the MQTT payload.
 
        @param bwPacket: bwPacket instance
        @return: dict with all fields of the packet"""
        if hasattr(bwPacket, '_packet'):
            return bwPacket._packet.copy()
        try:
            return {k: v for k, v in bwPacket.__dict__.items() if not k.startswith('_')}
        except Exception as e:
            logging.warning("MQTT Plugin: could not read packet fields: %s", e)
            return {}

Field Documentation

brokerAddress

plugin.mqtt.BoswatchPlugin.brokerAddress

brokerPort

plugin.mqtt.BoswatchPlugin.brokerPort

topicTemplate

plugin.mqtt.BoswatchPlugin.topicTemplate

clientId

plugin.mqtt.BoswatchPlugin.clientId

username

plugin.mqtt.BoswatchPlugin.username

password

plugin.mqtt.BoswatchPlugin.password

qos

plugin.mqtt.BoswatchPlugin.qos

retain

plugin.mqtt.BoswatchPlugin.retain

keepalive

plugin.mqtt.BoswatchPlugin.keepalive

statusTopic

plugin.mqtt.BoswatchPlugin.statusTopic

queueSize

plugin.mqtt.BoswatchPlugin.queueSize

maxRetries

plugin.mqtt.BoswatchPlugin.maxRetries

initialDelay

plugin.mqtt.BoswatchPlugin.initialDelay

maxDelay

plugin.mqtt.BoswatchPlugin.maxDelay

sender

plugin.mqtt.BoswatchPlugin.sender