Skip to main content

Flightradar client library.

Project description

python-flightradar-client

Build Status codecov PyPi Version

This library provides convenient access to a local Flightradar24 feed.

Installation

pip install flightradar-client

Usage

This library currently support two different flavour of flight data, provided by the fr24feed and dump1090-mutability services that are automatically installed when building your own Pi24 ADS-B receiver.

For each flavour the library provides two modes of access. The *Feed class fetches data once when calling update and transforms it into FeedEntry objects. The *FeedAggregator class keeps a bit of history and with each subsequent update call it tries to fill in any gaps (coordinates and callsign at the moment) missing in the latest data set fetched.

Flightradar Feed

The Flightradar Feed mode uses the JSON data made available by the fr24feed service (normally under http://localhost:8754/flights.json).

FlightradarFlightsFeed and FlightradarFlightsFeedAggregator support the same parameters:

Name Type Description
home_coordinates required, tuple of latitude and longitude Used to calculate the distance to each aircraft.
websession required, a aiohttp.ClientSession() session for retrieving data
filter_radius optional, float value in kilometres, default: don't filter by distance Only aircrafts within this radius around the home coordinates are included in the result set.
url optional, full url to access the Pi24 ADS-B receiver JSON, default: construct with hostname and port Define if you have customised access to Pi24 ADS-B receiver or use HTTPS for example.
hostname optional, hostname of the Pi24 ADS-B receiver, default: localhost Define if you are not running this library on your Pi24 ADS-B receiver.
port optional, port of the Pi24 ADS-B receiver's flights service, default: 8754 Define if you have configured a different port on your Pi24 ADS-B receiver.

Feed

import asyncio
from aiohttp import ClientSession
from flightradar_client.fr24feed_flights import FlightradarFlightsFeed
async def main() -> None:
    async with ClientSession() as websession:
        # Home Coordinates: Latitude: -33.5, Longitude: 151.5
        feed = FlightradarFlightsFeed((-33.5, 151.5), websession)
        status, entries = await feed.update()
        print(status)
        print(entries)
asyncio.get_event_loop().run_until_complete(main())

Feed Aggregator

import asyncio
from aiohttp import ClientSession
from flightradar_client.fr24feed_flights import FlightradarFlightsFeedAggregator
async def main() -> None:
    async with ClientSession() as websession:
        # Home Coordinates: Latitude: -33.5, Longitude: 151.5
        feed = FlightradarFlightsFeedAggregator((-33.5, 151.5), websession)
        status, entries = await feed.update()
        print(status)
        print(entries)
asyncio.get_event_loop().run_until_complete(main())

Dump1090 Feed

The Dump1090 Feed mode uses the JSON data made available by the dump1090-mutability service (normally under http://localhost:8888/data/aircraft.json).

Dump1090AircraftsFeed and Dump1090AircraftsFeedAggregator support the same parameters:

Name Type Description
home_coordinates required, tuple of latitude and longitude Used to calculate the distance to each aircraft.
websession required, a aiohttp.ClientSession() session for retrieving data
filter_radius optional, float value in kilometres, default: don't filter by distance Only aircrafts within this radius around the home coordinates are included in the result set.
url optional, full url to access the Pi24 ADS-B receiver JSON, default: construct with hostname and port Define if you have customised access to Pi24 ADS-B receiver or use HTTPS for example.
hostname optional, hostname of the Pi24 ADS-B receiver, default: localhost Define if you are not running this library on your Pi24 ADS-B receiver.
port optional, port of the Pi24 ADS-B receiver's dump1090 service, default: 8888 Define if you have configured a different port on your Pi24 ADS-B receiver.

Feed

import asyncio
from aiohttp import ClientSession
from flightradar_client.dump1090_aircrafts import Dump1090AircraftsFeed
async def main() -> None:
    async with ClientSession() as websession:
        # Home Coordinates: Latitude: -33.5, Longitude: 151.5
        feed = Dump1090AircraftsFeed((-33.5, 151.5), websession)
        status, entries = await feed.update()
        print(status)
        print(entries)
asyncio.get_event_loop().run_until_complete(main())

Feed Aggregator

import asyncio
from aiohttp import ClientSession
from flightradar_client.dump1090_aircrafts import Dump1090AircraftsFeedAggregator
async def main() -> None:
    async with ClientSession() as websession:
        # Home Coordinates: Latitude: -33.5, Longitude: 151.5
        feed = Dump1090AircraftsFeedAggregator((-33.5, 151.5), websession)
        status, entries = await feed.update()
        print(status)
        print(entries)
asyncio.get_event_loop().run_until_complete(main())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flightradar_client-0.8.tar.gz (11.3 kB view hashes)

Uploaded source

Built Distribution

flightradar_client-0.8-py3-none-any.whl (17.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page