pyBMNotify/README.md

36 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2020-12-08 00:08:26 +00:00
# pyBMNotify
Monitors a defined set of Brandmeister talkgroups and callsigns for activity. It then sends push notifications via the following services for any transmission in / of the monitored talk groups / call signs:
* Pushover (https://pushover.net)
* Telegram (https://telegram.org)
* DAPNET (https://hampager.de)
2020-12-08 00:32:31 +00:00
In order to prevent message flooding, the script only notifes you again after 300 (configurable) seconds of silence in a TG or from a monitored call sign.
2020-12-08 00:08:26 +00:00
## Credits
2020-12-08 00:10:25 +00:00
Inspired by https://github.com/klinquist/bmPushNotification
2020-12-08 00:08:26 +00:00
## Requirements
* Python 3
2022-10-14 14:40:57 +00:00
* socketIO-client-nexux (install with _sudo pip3 install socketIO-client-nexus_)
2020-12-08 00:08:26 +00:00
2020-12-08 13:31:06 +00:00
If you want to be notified via Telegram, the following libraries need to be installed:
* telebot (install with _sudo pip3 install telebot_)
* telethon (install with _sudo pip3 install telethon_)
2020-12-08 13:31:06 +00:00
2020-12-08 00:08:26 +00:00
## Configuration
Configure _config.py_ to your needs. If you don't want push notifications, set the corresponding variables to False.
2020-12-08 00:08:26 +00:00
## Execution
```
# python3 pyBMNotify.py
```
2020-12-08 18:23:57 +00:00
You might want to use a terminal multiplexer like screen or tmux to keep pyBMNotify running when you close the terminal.