mirror of
https://github.com/Schrolli91/BOSWatch.git
synced 2025-12-06 07:42:03 +01:00
some small changes...
This commit is contained in:
JHCD
parent
86951d23ad
commit
9de516ef45
84
README.md
84
README.md
|
|
@ -12,30 +12,30 @@ The software was developed using the Multimon-NG code, a function in the real op
|
|||
unless you are developer you can use the develop-Branch - may be unstable!
|
||||
|
||||
### Features
|
||||
##### Implemented Features:
|
||||
- FMS, ZVEI and POCSAG512/1200/2400 decoding and Displaying
|
||||
- Plugin support for easy Functions extension
|
||||
##### Implemented features:
|
||||
- FMS, ZVEI and POCSAG512/1200/2400 decoding and displaying
|
||||
- Plugin support for easy functional extension
|
||||
- Filtering double alarms with adjustable time
|
||||
- Filtering Allowed, Denied and Range of POCSAG RIC´s
|
||||
- Filtering Data for each Typ/Plugin combination with RegEX
|
||||
- All configurations in seperate config File
|
||||
- Filtering allowed, denied and range of POCSAG RIC´s
|
||||
- Filtering data for each typ/plugin combination with RegEX
|
||||
- All configurations in a seperate config file
|
||||
- Data validation (plausibility test)
|
||||
- Logfiles for better Troubleshooting
|
||||
- verbose/quiet Mode for more/none information
|
||||
- Logfiles for better troubleshooting
|
||||
- verbose/quiet mode for more/none information
|
||||
|
||||
##### Features for the Future:
|
||||
- more Plugins
|
||||
##### Features for the future:
|
||||
- more plugins
|
||||
|
||||
|
||||
###Plugins
|
||||
##### Implemented Plugins:
|
||||
- MySQL (insert Data into MySQL Database [FMS|ZVEI|POC])
|
||||
- BosMon (send Data to BosMon Server [FMS|ZVEI|POC])
|
||||
##### Implemented plugins:
|
||||
- MySQL (insert data into MySQL database [FMS|ZVEI|POC])
|
||||
- httpRequest (send a request with parameter to an URL [FMS|ZVEI|POC])
|
||||
- eMail (send Mails [FMS|ZVEI|POC])
|
||||
- firEmergency [ZVEI|POC]
|
||||
- BosMon (send data to BosMon server [FMS|ZVEI|POC])
|
||||
- firEmergency (send data to firEmergency server [ZVEI|POC])
|
||||
|
||||
- for more Information to the Plugins see `config.ini`
|
||||
- for more Information to the plugins see `config.ini`
|
||||
|
||||
##### Plugins for the Future:
|
||||
- Ideas per Issues please
|
||||
|
|
@ -43,44 +43,44 @@ unless you are developer you can use the develop-Branch - may be unstable!
|
|||
|
||||
### Configuration
|
||||
##### boswatch.py
|
||||
Take a look into the Folder /config/
|
||||
Take a look into the folder /config/
|
||||
Rename `config.template.ini` to `config.ini`
|
||||
In the Section `[BOSWatch]` you can set double_alarm_time etc.
|
||||
In the Section `[Plugins]` you can activate or deactivate the Plugins
|
||||
For each Plugin that requires configurations a own Section with his Name is available
|
||||
For each plugin that requires configurations, a own Section with his name is available
|
||||
|
||||
For the other Functions see "Usage" below.
|
||||
For the other functions see "Usage" below.
|
||||
|
||||
##### Filtering Functions (RegEX)
|
||||
For the RegEX Filter Functions see Section `[Filters]`
|
||||
http://www.regexr.com/ - RegEX Test Tool an Documentation
|
||||
No Filter for a Typ/Plugin Combination = all Data pass
|
||||
For the RegEX filter functions see Section `[Filters]`
|
||||
http://www.regexr.com/ - RegEX test tool an documentation
|
||||
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)
|
||||
- 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))
|
||||
- TYP = the data typ (FMS|ZVEI|POC)
|
||||
- DATAFIELD = the field of the data array (See interface.txt)
|
||||
- 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
|
||||
|
||||
only ZVEI to all Plugins with 25### at 85.5MHz
|
||||
only ZVEI to all plugins with 25### at 85.5MHz
|
||||
testfilter = ZVEI;zvei;*;85500000;25[0-9]{3}
|
||||
|
||||
only POCSAG to MySQL with the text "ALARM:" in the Message
|
||||
only POCSAG to MySQL with the text "ALARM:" in the message
|
||||
pocTest = POC;msg;MySQL;*;ALARM:
|
||||
|
||||
##### Web Frontend
|
||||
Put the Files in Folder /wwww/ into your local Webserver Folder (/var/www/).
|
||||
Now you must edit the "config.php" with your Userdata to your local Database.
|
||||
For the Parsing Functions take a look into the parser.php
|
||||
##### Web frontend
|
||||
Put the files in folder /wwww/ into your local webserver folder (f.e. /var/www/).
|
||||
Now you must edit the "config.php" with your userdata to your local database.
|
||||
Take a look into the parser.php for the parsing functions
|
||||
|
||||
|
||||
### Usage
|
||||
`sudo python boswatch.py -f 85.235M -a FMS ZVEI`
|
||||
Starts boswatch at Frequency 85.235 MHz with the Demodulation Functions FMS and ZVEI.
|
||||
Starts boswatch at frequency 85.235 MHz with the demodulation functions FMS and ZVEI.
|
||||
Parameter -f/--freq and -a/--demod are required!
|
||||
|
||||
Help to all usable Parameters with `sudo python boswatch.py -h`
|
||||
Help to all usable parameters with `sudo python boswatch.py -h`
|
||||
|
||||
```
|
||||
usage: boswatch.py [-h] -f FREQ [-d DEVICE] [-e ERROR] -a
|
||||
|
|
@ -91,28 +91,28 @@ optional arguments:
|
|||
-h, --help show this help message and exit
|
||||
-f FREQ, --freq FREQ Frequency you want to listen
|
||||
-d DEVICE, --device DEVICE Device you want to use (Check with rtl_test)
|
||||
-e ERROR, --error ERROR Frequency-Error of your Device in PPM
|
||||
-e ERROR, --error ERROR Frequency-Error of your device in PPM
|
||||
-a {FMS,ZVEI,POC512,POC1200,POC2400} [{FMS,ZVEI,POC512,POC1200,POC2400} ...],
|
||||
--demod {FMS,ZVEI,POC512,POC1200,POC2400} [{FMS,ZVEI,POC512,POC1200,POC2400} ...]
|
||||
Demodulation Functions
|
||||
-s SQUELCH, --squelch SQUELCH Level of Squelch
|
||||
-v, --verbose Shows more Information
|
||||
-q, --quiet Shows no Information. Only Logfiles
|
||||
Demodulation functions
|
||||
-s SQUELCH, --squelch SQUELCH level of squelch
|
||||
-v, --verbose Shows more information
|
||||
-q, --quiet Shows no information. Only logfiles
|
||||
```
|
||||
|
||||
|
||||
### Installation
|
||||
You can easy install BOSWatch with the install.sh Script.
|
||||
- Download the install.sh in any Folder you want.
|
||||
- Download the install.sh in any folder you want.
|
||||
- Make it executeable `sudo chmod +x install.sh`
|
||||
- And use the script `sudo sh install.sh`
|
||||
|
||||
Now the script downloads and compile all needed data.
|
||||
At the end you can find BOSWatch in `~/boswatch/`
|
||||
Rename `config.template.ini` to `config.ini` and configure
|
||||
In case of an Error during the Installation, check the Logfile in `~/boswatch/install/setup_log.txt`
|
||||
In case of an error during the installation, check the logfile in `~/boswatch/install/setup_log.txt`
|
||||
|
||||
Caution, script don't install a Webserver with PHP and MySQL.
|
||||
Caution, script don't install a webserver with PHP and MySQL.
|
||||
So you have to make up manually if you want to use MySQL support.
|
||||
|
||||
|
||||
|
|
@ -120,4 +120,4 @@ So you have to make up manually if you want to use MySQL support.
|
|||
- RTL_SDR (rtl_fm)
|
||||
- Multimon-NG
|
||||
- Python Support
|
||||
- MySQL Connector for Python
|
||||
- MySQL Connector for Python (for MySQL-plugin)
|
||||
|
|
|
|||
Loading…
Reference in a new issue