multicastAlarm added as function

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### __[v2.2.3]__ - unreleased
 ##### Added
+- zuschaltbare POCSAG Multicast-Alarm Funktionalität
 ##### Changed
 ##### Deprecated
 ##### Removed

README.md

@@ -47,6 +47,7 @@ unless you are developer you can use the develop-Branch - may be unstable!
 - Ready for use BOSWatch as daemon
 - possibility to start plugins asynchron
 - NMA Error Handler
+- multicastAlarm for transmission optimized networks
 
 
 ### Plugins

boswatch.py

@@ -217,6 +217,8 @@
 		# if given loglevel is debug:
 		if globalVars.config.getint("BOSWatch","loglevel") == 10:
 			configHandler.checkConfig("BOSWatch")
+			configHandler.checkConfig("multicastAlarm")
+			configHandler.checkConfig("Filters")
 			configHandler.checkConfig("FMS")
 			configHandler.checkConfig("ZVEI")
 			configHandler.checkConfig("POC")

citest/testdata.txt

@@ -35,7 +35,7 @@ POCSAG512: Address: 1000003  Function: 3  Alpha:   BOSWatch-Test: okay
 POCSAG512: Address: 1200001  Function: 1  Alpha:   BOSWatch-Test ÖÄÜß: okay
 POCSAG512: Address: 1200001  Function: 1  Alpha:   BOSWatch-Test öäü: okay
 
-# witch csv
+# with csv
 POCSAG512: Address: 1234567  Function: 1  Alpha:   BOSWatch-Test: with csv
 
 # without csv
@@ -86,6 +86,22 @@ POCSAG1200: Address: 7777777  Function: 1  Alpha:   BOSWatch-Test: denied
 POCSAG1200: Address: 0000004  Function: 1  Alpha:   BOSWatch-Test: out of filter start
 POCSAG1200: Address: 9000000  Function: 1  Alpha:   BOSWatch-Test: out of filter end
 
+#Probealram
+POCSAG1200: Address: 0871004  Function: 1  Alpha:   Dies ist ein Probealarm!
+## Multicast Alarm
+POCSAG1200: Address: 0871002  Function: 0  Alpha:   <EOT><FF>
+POCSAG1200: Address: 0860001  Function: 0 
+POCSAG1200: Address: 0860002  Function: 0 
+POCSAG1200: Address: 0860003  Function: 0 
+POCSAG1200: Address: 0860004  Function: 0 
+POCSAG1200: Address: 0860005  Function: 0 
+POCSAG1200: Address: 0860006  Function: 0 
+POCSAG1200: Address: 0860007  Function: 0 
+POCSAG1200: Address: 0860008  Function: 0 
+POCSAG1200: Address: 0860009  Function: 0 
+POCSAG1200: Address: 0860010  Function: 0 
+POCSAG1200: Address: 0871003  Function: 0  Alpha:   B2 Feuer Gebäude Pers in Gefahr. bla bla bla<NUL>
+
 # regEx-Filter?
 
 

config/config.template.ini

@@ -130,6 +130,25 @@ ricd = Unwetter
 netIdent_ric = 0174760, 1398098
 
 
+[multicastAlarm]
+# Configure multicastAlarm if your POCSAG network uses an optimized transmission scheme for alarms with more than one RIC (often found in Swissphone networks).
+# The optimized transmission scheme sends a POCSAG telegram with each RIC that needs to be alarmed in a sequence. These telegrams are send without a text message. This sequence is directly followed by a telegram with a special RIC and the text message.
+# A POCSAG pager (DME) can be configured to start an acoustic alarm if a specific RIC without text has been received. If afterwards the RIC with the text message will be received, the pager will show the message in it's display.
+# multicastAlarm enables BOSwatch to forward the all received RIC joined with the text message
+#
+# enable multicastAlarm (0 - off | 1 - on)
+multicastAlarm = 0
+
+# time limit for alarms that do not belong to the multicastAlarm sequence in seconds
+multicastAlarm_ignore_time = 15
+
+# multicastAlarm delimiter RIC (usually used as a starting point for a alarm sequence) (can be empty)
+multicastAlarm_delimiter_ric =
+
+# multicastAlarm RIC that is used to send the text message
+multicastAlarm_ric =
+
+
 [Filters]
 # RegEX Filter Configuration
 # http://www.regexr.com/ - RegEX Test Tool an Documentation

includes/decoders/poc.py

@@ -127,13 +127,24 @@ def decode(freq, decoded):
 						if globalVars.config.getint("POC", "idDescribed"):
 							from includes import descriptionList
 							data["description"] = descriptionList.getDescription("POC", poc_id+data["functionChar"])
-						# processing the alarm
-						try:
-							from includes import alarmHandler
-							alarmHandler.processAlarmHandler("POC", freq, data)
-						except:
-							logging.error("processing alarm failed")
-							logging.debug("processing alarm failed", exc_info=True)
+						# multicastAlarm processing if enabled and message without text ord delimiter RIC received
+						if globalVars.config.getint("multicastAlarm", "multicastAlarm") and (poc_text == "" or poc_id == globalVars.config.get("multicastAlarm", "multicastAlarm_delimiter_ric")):
+							logging.debug("POCSAG%s: %s %s %s - multicastAlarm or delimiter RIC received - buffer until text received", bitrate, poc_id, poc_sub, poc_text)
+							from includes import multicastAlarm
+							multicastAlarm.newEntrymultiList("POC", poc_id, poc_sub, poc_text)
+						# multicastAlarm processing if enabled and alarm message has been received
+						elif globalVars.config.getint("multicastAlarm", "multicastAlarm") and poc_text != "" and poc_id == globalVars.config.get("multicastAlarm", "multicastAlarm_ric"):
+							logging.debug("EA RIC with text message - POCSAG%s: %s %s %s", bitrate, poc_id, poc_sub, poc_text)
+							from includes import multicastAlarm
+							multicastAlarm.multicastAlarmExec("POC", freq, data)
+						else:
+							# processing the alarm
+							try:
+								from includes import alarmHandler
+								alarmHandler.processAlarmHandler("POC", freq, data)
+							except:
+								logging.error("processing alarm failed")
+								logging.debug("processing alarm failed", exc_info=True)
 					# in every time save old data for double alarm
 					doubleFilter.newEntry(poc_id+poc_sub, poc_text)
 				else:

includes/multicastAlarm.py

@@ -0,0 +1,65 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""
+multicastAlarm is the function to enable BOSwatch to deal networks that optimise the transmission of POCSAG telegrams
+
+@author: Fabian Kessler
+
+@requires: Configuration has to be set in the config.ini
+"""
+
+import logging # Global logger
+import time    # timestamp for multicastAlarm
+
+from includes import globalVars  # Global variables
+
+multiList = []
+
+def newEntrymultiList(eatyp, eapoc_id, eapoc_sub, eapoc_text):
+	"""
+	add entry to multi alarm list and remove old entries
+
+	@return:    nothing
+	"""
+	global multiList
+	tmpmultiList = []
+	timestamp = int(time.time())
+	# multicastAlarm processing if enabled and delimiter RIC has been received
+	if eapoc_id == globalVars.config.get("multicastAlarm", "multicastAlarm_delimiter_ric"):
+		multiList = []
+		logging.debug("multicastAlarm delimiter RIC received --> buffer cleared  %s  %s %s ", eapoc_id, eapoc_sub, eapoc_text)
+	else:
+		multiList.append([eatyp, eapoc_id, eapoc_sub, eapoc_text.strip(), timestamp])
+		logging.debug("Added %s  %s %s to multiList", eapoc_id, eapoc_sub, eapoc_text)
+		# check for old entries in multiList
+		for i,j in enumerate(multiList):
+			# we have to remove entries older than timestamp - ignore time
+			if int(multiList[i][4]) > timestamp-globalVars.config.getint("multicastAlarm", "multicastAlarm_ignore_time"):
+				tmpmultiList.append(multiList[i])
+	multiList = tmpmultiList
+
+
+def multicastAlarmExec(typ, freq, data):
+	"""
+	call alarmHandler for every entry in multiList
+
+	@return:    nothing
+	"""
+	logging.debug("data before update from multiList: %s", data)
+	for i,j in enumerate(multiList):
+		#update with eapoc_id (RIC)
+		data['ric'] =  multiList[i][1]
+		#update with eapoc_sub (Sub RIC)
+		data['function'] = multiList[i][2]
+		# Add function as character a-d to dataset (reused from includes/poc.py)
+		data["functionChar"] = data["function"].replace("1", "a").replace("2", "b").replace("3", "c").replace("4", "d")
+		#update with eapoc_id (RIC)
+		data['description'] = multiList[i][1]
+		logging.debug("data after update from multiList: %s", data)
+		try:
+			from includes import alarmHandler
+			alarmHandler.processAlarmHandler(typ, freq, data)
+		except:
+			logging.error("processing alarm failed")
+			logging.debug("processing alarm failed", exc_info=True)