adsbTelegramNotifier

Notifies via Telegram when an aircraft passes over a certain area.
The script gets the data from an existing readsb or dump1090 installation (aircraft.json).

Dependencies

Install the dependencies via:
sudo apt install curl php-cli php-json php-curl -y
You also need a decoder instance, such as readsb or dump1090.

Install

Go to the directory where you want to install the notifier, clone Repository, rename config.template.php to config.php and edit the config file.

cd ~
git clone https://github.com/RundesBalli/adsbTelegramNotifier.git
cd adsbTelegramNotifier
mv includes/config.template.php includes/config.php
nano includes/config.php

Update in version 2: This notifier is now run via a systemd service, not by cron anymore!

Telegram Bot

1. Create a bot with the BotFather and note the bot auth token.
2. Get the chat ID: Decide if you want to get notifications via private chat or in a group chat.

• Private: Send a message to the Chat ID Bot.
• Group: Invite the Chat ID Bot to your group (can be kicked immediately after that).

3. Enter the bot auth token and the chat ID in the includes/config.php.
4. Initialize the bot:

• Private: you must first send a message to your bot (e.g. /start or click the start button in the bot) to initialize the chat with the bot. Otherwise it will fail until first contact from you (antispam reasons). Note that the bot will not reply to your message.
• Group: You have to invite the bot to your group. Thats it.

Test the Bot / Debug / Troubleshooting

To test the bot, you can simply run it with PHP in the CLI:
php notifier.php (CTRL+C to exit)

If you just want to know if the telegram chat ID and bot token is correct, you can run:
php notifier.php --test-telegram
It will send a test message to the configured chat ID.

The bot has a detailed output in the CLI, which makes debugging extremely easy. When the script is run as a service, the standard output will be discarded and only the critical and warning error messages will be logged.

Automatic notifications

1. Get the full directory:
   pwd
2. Edit the ExecStart-path in the service file:
   nano adsbTelegramNotifier.service
3. Create a systemlink to the service file:
   sudo ln -s /path/to/adsbTelegramNotifier/adsbTelegramNotifier.service /etc/systemd/system/adsbTelegramNotifier.service
4. Enable and start the service:
   sudo systemctl enable adsbTelegramNotifier && sudo systemctl start adsbTelegramNotifier
5. Check if the service has started:
   sudo systemctl status adsbTelegramNotifier

More information (readsb/tar1090 only)

The default setup shows the HEX Code (ICAO) and the Flightnumber/Callsign if available.
If you want to know more information about the aircraft (registration, aircraft-type, dbFlags) you can add more data to the aircraft.json.
As seen in wiedehopfs tutorial you can download a aircraft.csv file and include it into readsb to get more data.

sudo wget -O /usr/local/share/tar1090/aircraft.csv.gz https://github.com/wiedehopf/tar1090-db/raw/csv/aircraft.csv.gz
sudo nano /etc/default/readsb

Add the following line in one of the readsb parameter lines:
--db-file /usr/local/share/tar1090/aircraft.csv.gz --db-file-lt

For example:

DECODER_OPTIONS="--max-range 450 --write-json-every 1"

becomes:

DECODER_OPTIONS="--max-range 450 --write-json-every 1 --db-file /usr/local/share/tar1090/aircraft.csv.gz --db-file-lt"

Restart readsb:
sudo systemctl restart readsb

Contribute

If you want to contribute to the project, you are welcome to do the translations into your local language. But no matter what you want to contribute, just send a PR and I'll take a look at it.