Merge pull request #5 from dg9vh/patch-2

Update README.md
This commit is contained in:
Antonio Matraia 2021-03-24 09:57:06 +01:00 committed by GitHub
commit a8a37a739b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 22 deletions

View File

@ -1,37 +1,39 @@
pYSFReflector # pYSFReflector
This is a YSF Reflector implemented in python3, mainly compatible with g4klx reflector. This is a YSF Reflector implemented in python3, mainly compatible with g4klx reflector.
Additional Features ## Additional Features
Enhanced Blocking List ### Enhanced Blocking List
With the enhanced blocking list you are able to mute calls based on With the enhanced blocking list you are able to mute calls based on
callsign of sender * callsign of sender
callsign of gateway used * callsign of gateway used
ip-address of gateway * ip-address of gateway
Blocking On Regular Expression Callsign Check
### Blocking On Regular Expression Callsign Check
It is also possible to use (by default enabled in the YSFReflector.ini) a callsign check based on a regular expression to check the callsign plausibility in callsign-format and length. It is also possible to use (by default enabled in the YSFReflector.ini) a callsign check based on a regular expression to check the callsign plausibility in callsign-format and length.
The result of this check can be overdriven by a whitelist-entry in the blocklist (for example: N0CALL is blocked by default by this expression but could be allowed for special bridging situations). The result of this check can be overdriven by a whitelist-entry in the blocklist (for example: N0CALL is blocked by default by this expression but could be allowed for special bridging situations).
Avoiding Parallel Incomming Transmissions ### Avoiding Parallel Incomming Transmissions
There is also a functionality implemented that prohibits parallel transmissions that can happen if two senders transmit at the same time. Here the principle 'first-comes-first-serves' is realized, so the second station in time will just be muted to not disturb the audio. There is also a functionality implemented that prohibits parallel transmissions that can happen if two senders transmit at the same time. Here the principle 'first-comes-first-serves' is realized, so the second station in time will just be muted to not disturb the audio.
Easy Installation And Upgrade ## Easy Installation And Upgrade
Depending on your used operating system and python3-installation you just have to take care that following libraries are installed: Depending on your used operating system and python3-installation you just have to take care that following libraries are installed:
socket * socket
threading * threading
queue * queue
sys * sys
os * os
time * time
re * re
configparser * configparser
datetime * datetime
signal * signal
datetime * datetime
bisect * bisect
struct * struct
In most installations this packages are already installed, otherwise you easily can install them with your system-package-manager (for example Debian: apt) or you use pip3 install <package>-command. In most installations this packages are already installed, otherwise you easily can install them with your system-package-manager (for example Debian: apt) or you use pip3 install <package>-command.
The configuration file (YSFReflector.ini) is based on the origin YSFReflector.ini of G4KLX's YSFReflector but with added new configuration-items. So If you know the old reflector-software - configuring this one would be straight forward. The configuration file (YSFReflector.ini) is based on the origin YSFReflector.ini of G4KLX's YSFReflector but with added new configuration-items. So If you know the old reflector-software - configuring this one would be straight forward.