mirror of
https://github.com/Schrolli91/BOSWatch.git
synced 2025-12-06 07:42:03 +01:00
edit readme
wiki doubles deleted
This commit is contained in:
parent
c698a9eb15
commit
8beb46f55a
72
README.md
72
README.md
|
|
@ -16,6 +16,10 @@ In der Zukunft wollen wir die Möglichkeit schaffen, codierte Nachrichten zu ent
|
||||||
|
|
||||||
:satellite: Python Script to receive and decode German BOS Information with rtl_fm and multimon-NG :satellite:
|
:satellite: Python Script to receive and decode German BOS Information with rtl_fm and multimon-NG :satellite:
|
||||||
|
|
||||||
|
#### WICHTIG
|
||||||
|
**Es wird darauf hingewiesen, dass für die Teilnahme am BOS-Funk nur nach den Technischen Richtlinien der BOS zugelassene Funkanlagen verwendet werden dürfen.**
|
||||||
|
**Der BOS-Funk ist ein nichtöffentlicher mobiler Landfunk. Privatpersonen gehören nicht zum Kreis der berechtigten Funkteilnehmer.** _(Quelle: TR-BOS)_
|
||||||
|
|
||||||
#### Notice:
|
#### Notice:
|
||||||
The intercept of the German BOS radio is **strictly prohibited** and will be prosecuted. the use is **only authorized** personnel permitted.
|
The intercept of the German BOS radio is **strictly prohibited** and will be prosecuted. the use is **only authorized** personnel permitted.
|
||||||
The software was developed using the Multimon-NG code, a function in the real operation can not be guaranteed.
|
The software was developed using the Multimon-NG code, a function in the real operation can not be guaranteed.
|
||||||
|
|
@ -23,10 +27,13 @@ The software was developed using the Multimon-NG code, a function in the real op
|
||||||
|
|
||||||
**Please** only use Code from **master**-Branch - thats **the only stable!**
|
**Please** only use Code from **master**-Branch - thats **the only stable!**
|
||||||
|
|
||||||
|
beta-branch is for beta-test of new features
|
||||||
|
|
||||||
unless you are developer you can use the develop-Branch - may be unstable!
|
unless you are developer you can use the develop-Branch - may be unstable!
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
##### Implemented features:
|
##### Implemented features:
|
||||||
|
**list is not complete!**
|
||||||
- FMS, ZVEI and POCSAG512/1200/2400 decoding and displaying
|
- FMS, ZVEI and POCSAG512/1200/2400 decoding and displaying
|
||||||
- Plugin support for easy functional extension
|
- Plugin support for easy functional extension
|
||||||
- Filtering double alarms with adjustable time and check width
|
- Filtering double alarms with adjustable time and check width
|
||||||
|
|
@ -41,30 +48,12 @@ unless you are developer you can use the develop-Branch - may be unstable!
|
||||||
- possibility to start plugins asynchron
|
- possibility to start plugins asynchron
|
||||||
- NMA Error Handler
|
- NMA Error Handler
|
||||||
|
|
||||||
##### Features for the future:
|
|
||||||
- more plugins
|
|
||||||
- other Ideas per Issues please
|
|
||||||
|
|
||||||
|
|
||||||
### Plugins
|
### Plugins
|
||||||
If you want to code your own Plugin, see `plugins/README.md`.
|
If you want to code your own Plugin, see `plugins/README.md`.
|
||||||
|
|
||||||
##### Implemented plugins:
|
##### Implemented plugins:
|
||||||
|
please look at the wiki page
|
||||||
|Plugin|Function|FMS|ZVEI|POC|
|
|
||||||
|-----|---------|:-:|:--:|:-:|
|
|
||||||
|MySQL|insert data into MySQL database|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|httpRequest|send a request with parameter to an URL|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|eMail|send Mails with own text|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|BosMon|send data to BosMon server|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|firEmergency|send data to firEmergency server|:x:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|jsonSocket|send data as jsonString to a socket server|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|NMA|send data to Notify my Android|:white_check_mark:|:white_check_mark:|:white_check_mark:|
|
|
||||||
|
|
||||||
- for more Information to the plugins see `config.ini`
|
|
||||||
|
|
||||||
##### Plugins for the Future:
|
|
||||||
- Ideas per Issues please
|
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
@ -105,52 +94,15 @@ Take a look into the parser.php for the parsing functions~~
|
||||||
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
`sudo python boswatch.py -f 85.235M -a FMS ZVEI`
|
please look at the wiki page
|
||||||
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`
|
|
||||||
|
|
||||||
```
|
|
||||||
usage: boswatch.py [-h] -f FREQ [-d DEVICE] [-e ERROR] -a
|
|
||||||
{FMS,ZVEI,POC512,POC1200,POC2400}
|
|
||||||
[{FMS,ZVEI,POC512,POC1200,POC2400} ...] [-s SQUELCH] [-v]
|
|
||||||
|
|
||||||
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
|
|
||||||
-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
|
|
||||||
-u, --usevarlog Use '/var/log/boswatch' for logfiles instead of subdir 'log' in BOSWatch directory
|
|
||||||
-v, --verbose Shows more information
|
|
||||||
-q, --quiet Shows no information. Only logfiles
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
Please follow the instructions written down in the wiki:
|
please look at the wiki page
|
||||||
|
|
||||||
https://github.com/Schrolli91/BOSWatch/wiki
|
|
||||||
|
|
||||||
You just need to download a single file since the installer manages the whole process except the installation of a webserver and a database.
|
|
||||||
|
|
||||||
If you want to use BOSWatch as a daemon, you have to set your
|
If you want to use BOSWatch as a daemon, you have to set your
|
||||||
configuration in `service/boswatch.sh` and copy it to `/etc/init.d`.
|
configuration in `service/boswatch.sh` and copy it to `/etc/init.d`.
|
||||||
Then you can start BOSWatch with `sudo /etc/init.d/boswatch.sh start`.
|
Then you can start BOSWatch with `sudo /etc/init.d/boswatch.sh start`.
|
||||||
For configuration-details see `service/README.md`.
|
For configuration-details see `service/README.md`.
|
||||||
|
|
||||||
### Requirements
|
##### Big thanks
|
||||||
- RTL_SDR (rtl_fm)
|
to smith_fms and McBo from Funkmeldesystem.de - Forum for Inspiration and Groundwork!
|
||||||
- Multimon-NG
|
|
||||||
- Python Support
|
|
||||||
- MySQL Connector for Python (for MySQL-plugin)
|
|
||||||
|
|
||||||
Thanks to smith_fms and McBo from Funkmeldesystem.de - Forum for Inspiration and Groundwork!
|
|
||||||
|
|
||||||
|
|
||||||
### Code your own Plugin
|
|
||||||
See `plugins/README.md`
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue