Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nfacha/planealert

Track planes by ICAO, Type, Operator and Squawk and issue notifications on Mastodon, Discord, and Twitter
https://github.com/nfacha/planealert

adsb adsbexchange discord mastodon mastodon-bot plane radarplane rtl-sdr twitter

Last synced: 1 day ago
JSON representation

Track planes by ICAO, Type, Operator and Squawk and issue notifications on Mastodon, Discord, and Twitter

Awesome Lists containing this project

README

        

[![wakatime](https://wakatime.com/badge/user/65ddcee5-893d-45e3-989c-4d52691b9072/project/cb52da0e-7317-4d00-97da-47004445e1f5.svg)](https://wakatime.com/badge/user/65ddcee5-893d-45e3-989c-4d52691b9072/project/cb52da0e-7317-4d00-97da-47004445e1f5)

![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/nfacha/PlaneAlert?label=Latest%20version)
![GitHub Release Date](https://img.shields.io/github/release-date/nfacha/PlaneAlert)
![GitHub last commit](https://img.shields.io/github/last-commit/nfacha/PlaneAlert)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c40766e76d3d468b996d23fc7edcfd85)](https://www.codacy.com/gh/nfacha/PlaneAlert/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nfacha/PlaneAlert&utm_campaign=Badge_Grade)

![GitHub Repo stars](https://img.shields.io/github/stars/nfacha/PlaneAlert?style=social)
![GitHub watchers](https://img.shields.io/github/watchers/nfacha/PlaneAlert?style=social)

[![Discord](https://img.shields.io/discord/933444164379619348)](https://discord.gg/ecyK3y4zTW)

# PlaneAlert

## Like this project? Don't forget to STAR it and follow it for future releases :)

## Some Mastodon accounts running PlaneAlert:

[@planeemergency](https://airwaves.social/@planeemergency) - Tracking Aircraft declaring an emergency

[@ryanairtracker](https://airwaves.social/@ryanairtracker) - Tracking Rayanair flights

[@interestingplanes](https://airwaves.social/@interestingplanes) - Tracking the movement of some interesting military
and civilian planes

[@russiatracker](https://airwaves.social/@russiatracker) - Planes known to be associated with the #Russian government or
Russian oligartchs

## Features

- Support multiple data sources (api.facha.dev, OpenSky, Dump1090, RadarPlane or Virtual Radar Server), with an easy way
to add your own
- One instance can track multiple Aircraft
- Track Aircrafts by ICAO Hex
- Track whole Airlines
- Track all aircrafts of a specific type (Like track all B-52s at once)
- Track all aircraft broadcasting a specific squawk (such as 7500,7600,7700)
- Send out alerts on Discord, Twitter and Mastodon (with screenshots)
- Calculate the nearest airport to the aircraft on signal loss
- Full Docker support

## TrackSources

The following TrackSources are supported:

- `FachaDev` - This is the default and RECOMMENDED TrackSource, that support all current
Features | https://api.facha.dev
- `VRS` - This connects to your own Virtual Radar Server | (Self-Hosted)
- `OPSN` - OpenSkyNetwork | (https://openskynetwork.github.io/opensky-api/rest.html)
- `dump1090` - Dump1090 Aircraft.Json | Get data from your local Dump1090 Feeder
- `RadarPlane` - RadarPlane.com | (https://radarplane.com/api)

At this time airlines, squawk and type queries are only supported by the FachaDev TrackSource, and will not work if
another source is selected

## Usage

1. Clone the repo and cd into its directory
2. On the `config` folder copy the `main.yaml.example` as `main.yaml` and edit it to your needs
3. On this same `config` folder you will see four folders `aircraft`, `airlines` and `squawk`, and `types`, all this
folders will contain an example file, to add a track of that type you just need to copy that file over and adjust its
settings as needed
4. Run `docker-compose up -d` to start the services