From 6e6a0a4a45ce54f5518b90132636d849611d63e5 Mon Sep 17 00:00:00 2001 From: Bastian Schroll Date: Sun, 2 Oct 2016 12:38:47 +0200 Subject: [PATCH] edit interface.txt info information now in plugins/readme.md --- README.md | 2 +- config/config.template.ini | 2 +- includes/alarmHandler.py | 4 ++-- includes/filter.py | 2 +- includes/helper/wildcardHandler.py | 2 +- plugins/BosMon/BosMon.py | 2 +- plugins/FFAgent/FFAgent.py | 2 +- plugins/MySQL/MySQL.py | 2 +- plugins/Pushover/Pushover.py | 2 +- plugins/SMS/SMS.py | 2 +- plugins/Sms77/Sms77.py | 2 +- plugins/Telegram/Telegram.py | 2 +- plugins/eMail/eMail.py | 2 +- plugins/firEmergency/firEmergency.py | 2 +- plugins/httpRequest/httpRequest.py | 2 +- plugins/jsonSocket/jsonSocket.py | 2 +- plugins/notifyMyAndroid/notifyMyAndroid.py | 2 +- plugins/template/template.py | 2 +- 18 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e4520f4..d139106 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ No filter for a combination typ/plugin = all data will pass Syntax: `INDIVIDUAL_NAME = TYP;DATAFIELD;PLUGIN;FREQUENZ;REGEX` (separator `;`) - `TYP` = the data typ (FMS|ZVEI|POC) -- `DATAFIELD` = the field of the data array (See interface.txt) +- `DATAFIELD` = the field of the data array (see readme.md in plugin folder) - `PLUGIN` = the name of the plugin to call with this filter (* for all) - `FREQUENZ` = the frequenz to use the filter (for more SDR sticks (* for all)) - `REGEX` = the RegEX diff --git a/config/config.template.ini b/config/config.template.ini index 88ba901..97b82b9 100644 --- a/config/config.template.ini +++ b/config/config.template.ini @@ -105,7 +105,7 @@ idDescribed = 0 # No Filter for a Typ/Plugin Combination = all Data pass # INDIVIDUAL_NAME = TYP;DATAFIELD;PLUGIN;FREQUENZ;REGEX # TYP = the Data Typ (FMS|ZVEI|POC) -# DATAFIELD = the field of the Data Array (See interface.txt) +# DATAFIELD = the field of the Data Array (see readme.md in plugin folder) # PLUGIN = the name of the Plugin to call with this Filter (* for all) # FREQUENZ = the Frequenz to use the Filter (for more SDR Sticks (* for all)) # REGEX = the RegEX diff --git a/includes/alarmHandler.py b/includes/alarmHandler.py index 74eac6b..a65bc15 100644 --- a/includes/alarmHandler.py +++ b/includes/alarmHandler.py @@ -27,7 +27,7 @@ def processAlarmHandler(typ, freq, data): @param typ: Typ of the dataset @type freq: string @param freq: frequency of the SDR Stick - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @requires: active plugins in pluginList @@ -61,7 +61,7 @@ def processAlarm(typ, freq, data): @param typ: Typ of the dataset @type freq: string @param freq: frequency of the SDR Stick - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @requires: active plugins in pluginList diff --git a/includes/filter.py b/includes/filter.py index bf6ce57..3061e26 100644 --- a/includes/filter.py +++ b/includes/filter.py @@ -55,7 +55,7 @@ def checkFilters(typ, data, plugin, freq): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @type plugin: string @param plugin: Name of the plugin to checked diff --git a/includes/helper/wildcardHandler.py b/includes/helper/wildcardHandler.py index 1b45a32..720c297 100644 --- a/includes/helper/wildcardHandler.py +++ b/includes/helper/wildcardHandler.py @@ -22,7 +22,7 @@ def replaceWildcards(text, data, lineBrakeAllowed=False): @type text: string @param text: Input text with wildcards @type data: map - @param data: map of data (structure see interface.txt) + @param data: map of data (structure see readme.md in plugin folder) @type lineBrakeAllowed: Boolean @param lineBrakeAllowed: switch to allow lineBreak (%BR%) as wildcard diff --git a/plugins/BosMon/BosMon.py b/plugins/BosMon/BosMon.py index 7be0116..0e80231 100644 --- a/plugins/BosMon/BosMon.py +++ b/plugins/BosMon/BosMon.py @@ -90,7 +90,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset for sending to BosMon - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to BosMon. @type freq: string @keyword freq: frequency is not used in this plugin diff --git a/plugins/FFAgent/FFAgent.py b/plugins/FFAgent/FFAgent.py index e14a291..638d984 100644 --- a/plugins/FFAgent/FFAgent.py +++ b/plugins/FFAgent/FFAgent.py @@ -53,7 +53,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/MySQL/MySQL.py b/plugins/MySQL/MySQL.py index 7ba29c3..defce9b 100644 --- a/plugins/MySQL/MySQL.py +++ b/plugins/MySQL/MySQL.py @@ -73,7 +73,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset for sending to BosMon - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to BosMon. @type freq: string @keyword freq: frequency is not used in this plugin diff --git a/plugins/Pushover/Pushover.py b/plugins/Pushover/Pushover.py index 50112d5..2b9027f 100644 --- a/plugins/Pushover/Pushover.py +++ b/plugins/Pushover/Pushover.py @@ -48,7 +48,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/SMS/SMS.py b/plugins/SMS/SMS.py index bb5fc81..cbf97ac 100644 --- a/plugins/SMS/SMS.py +++ b/plugins/SMS/SMS.py @@ -73,7 +73,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/Sms77/Sms77.py b/plugins/Sms77/Sms77.py index 22e3f54..cc15c25 100644 --- a/plugins/Sms77/Sms77.py +++ b/plugins/Sms77/Sms77.py @@ -48,7 +48,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/Telegram/Telegram.py b/plugins/Telegram/Telegram.py index e328952..e32038d 100644 --- a/plugins/Telegram/Telegram.py +++ b/plugins/Telegram/Telegram.py @@ -61,7 +61,7 @@ def run(typ,freq,data): If necessary the configuration hast to be set in the config.ini. @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/eMail/eMail.py b/plugins/eMail/eMail.py index 5a42b95..4259882 100644 --- a/plugins/eMail/eMail.py +++ b/plugins/eMail/eMail.py @@ -87,7 +87,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset for sending via eMail - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to eMail. @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/firEmergency/firEmergency.py b/plugins/firEmergency/firEmergency.py index 329120f..2b287a1 100644 --- a/plugins/firEmergency/firEmergency.py +++ b/plugins/firEmergency/firEmergency.py @@ -53,7 +53,7 @@ def run(typ,freq,data): @type typ: string (ZVEI|POC) @param typ: Typ of the dataset for sending to firEmergency - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to firEmergency. @type freq: string @keyword freq: frequency is not used in this plugin diff --git a/plugins/httpRequest/httpRequest.py b/plugins/httpRequest/httpRequest.py index a795fd9..41d71bc 100644 --- a/plugins/httpRequest/httpRequest.py +++ b/plugins/httpRequest/httpRequest.py @@ -49,7 +49,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/jsonSocket/jsonSocket.py b/plugins/jsonSocket/jsonSocket.py index 8298897..84f256a 100644 --- a/plugins/jsonSocket/jsonSocket.py +++ b/plugins/jsonSocket/jsonSocket.py @@ -50,7 +50,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset for sending via UDP/TCP - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to UDP. @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/notifyMyAndroid/notifyMyAndroid.py b/plugins/notifyMyAndroid/notifyMyAndroid.py index c812c6a..b850d26 100644 --- a/plugins/notifyMyAndroid/notifyMyAndroid.py +++ b/plugins/notifyMyAndroid/notifyMyAndroid.py @@ -170,7 +170,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset for sending via UDP/TCP - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch to UDP. @type freq: string @keyword freq: frequency of the SDR Stick diff --git a/plugins/template/template.py b/plugins/template/template.py index 5e6ae42..962791c 100644 --- a/plugins/template/template.py +++ b/plugins/template/template.py @@ -62,7 +62,7 @@ def run(typ,freq,data): @type typ: string (FMS|ZVEI|POC) @param typ: Typ of the dataset - @type data: map of data (structure see interface.txt) + @type data: map of data (structure see readme.md in plugin folder) @param data: Contains the parameter for dispatch @type freq: string @keyword freq: frequency of the SDR Stick