Awesome

Flightradar24 integration for Home Assistant

Flightradar24 integration allows one to track overhead flights in a given region or particular planes. It will also fire Home Assistant events when flights enter/exit/landed/took off.

<b>IMPORTANT: No need FlightRadar24 subscription!</b>

It allows you:

1. Know how many flights in your area right now, or just have entered or exited it. And get list of flights with full information by every relevant flight for the sensor
2. Track a particular plane or planes no matter where it currently is, even if it is a scheduled flight
3. Get top 10 most tracked flights on FlightRadar24
4. Create notifications (example - Get a notification when a flight enters or exits your area, Get a notification when a tracked scheduled flight takes off)
5. Create automations (example - Automatically track a flight by your needs)
6. Add flights table to your Home Assistant dashboard by Lovelace Card)
7. Track your flight as Device Tracker
8. Get info for last flights which were in your area or get info about latest exited flight by creating Last Flights History Sensor

<img src="https://raw.githubusercontent.com/AlexandrErohin/home-assistant-flightradar24/master/docs/media/map.png" width="48%"><img src="https://raw.githubusercontent.com/AlexandrErohin/home-assistant-flightradar24/master/docs/media/sensors.png" width="48%">

Components

Events

• flightradar24_entry: Fired when a flight enters the region.
• flightradar24_exit: Fired when a flight exits the region.
• flightradar24_most_tracked_new: Fired when a new flight appears in top 10 most tracked flights on FlightRadar24
• flightradar24_area_landed: Fired when a flight lands in your area.
• flightradar24_area_took_off: Fired when a flight takes off in your area.
• flightradar24_tracked_landed: Fired when a tracked flight lands.
• flightradar24_tracked_took_off: Fired when a tracked flight takes off.

Sensors

• Current in area
• Entered area
• Exited area
• Additional tracked
• Most tracked flights (You may disable it via configuration)

<a id="device-tracker">Device Tracker</a>

Track flights as device_tracker with flight information. To use it - you need to activate this feature in Edit Configuration. When it is enabled - this integration creates device_tracker for every additional tracked flight from sensor.flightradar24_additional_tracked.

To create device_tracker for a flight:

1. Add a flight to Additional tracked by flight number. If it has no flight number, use callsign
2. Use device_tracker device_tracker.FLIGHT_NUMBER if flight number exists or device_tracker.CALL_SIGN.

To find device_tracker - Go to Developer tools and search for your flight number or callsign - you’ll find sensor like device_tracker.FLIGHT_NUMBER or device_tracker.CALL_SIGN.

Configuration

• Add to track
• Remove from track
• API data fetching - you may disable FlightRadar API calls when not needed to prevent unnecessary API calls and save bandwidth and server load.

Sensors shows how many flights in the given area, additional tracked, just have entered or exited it. All sensors have attribute flights with list of flight object contained a full information by every relevant flight for the sensor

Configuration inputs fields allows to add or remove a flight to/from sensor - Additional tracked. Adding/Removing supports flight number, call sign, aircraft registration number

Installation

HACS (recommended)

Have HACS installed, this will allow you to update easily.

<a href="https://my.home-assistant.io/redirect/hacs_repository/?owner=AlexandrErohin&repository=home-assistant-flightradar24&category=integration" target="_blank"><img src="https://my.home-assistant.io/badges/hacs_repository.svg" alt="Open your Home Assistant instance and open a repository inside the Home Assistant Community Store." /></a>

or go to <b>Hacs</b> and search for Flightradar24.

Manual

1. Locate the custom_components directory in your Home Assistant configuration directory. It may need to be created.
2. Copy the custom_components/flightradar24 directory into the custom_components directory.
3. Restart Home Assistant.

Configuration

Flightradar24 is configured via the GUI. See the HA docs for more details.

The default data is preset already

1. Go to the <b>Settings</b>-><b>Devices & services</b>.
2. Click on + ADD INTEGRATION, search for Flightradar24.
3. You may change the default values for Radius, Latitude and Longitude
4. Click SUBMIT

<a id="edit-configuration">Edit Configuration</a>

You may edit configuration data like:

1. Latitude and longitude of your point
2. Radius of your zone
3. Scan interval for updates in seconds
4. The minimum and maximum altitudes in foots between which the aircraft will be tracked
5. Enable/Disable top 10 most tracked flights on FlightRadar24
6. Enable/Disable device_tracker for flights
7. Username and password if you have FlightRadar24 subscription

To do that:

1. Go to the <b>Settings</b>-><b>Devices & services</b>.
2. Search for Flightradar24, and click on it.
3. Click on CONFIGURE
4. Edit the options you need and click SUBMIT

Uses

<a id="notification-enters">Notification - When a flight enters or exits your area</a>

To receive notifications of the entering flights add following lines to your configuration.yaml file:

automation:
  - alias: "Flight entry notification"
    trigger:
      platform: event
      event_type: flightradar24_entry
    action:
      service: notify.mobile_app_<device_name>
      data:
        message: >-
          Flight entry of {{ trigger.event.data.callsign }} to {{ trigger.event.data.airport_destination_city }}
          [Open FlightRadar](https://www.flightradar24.com/{{ trigger.event.data.callsign }})
        data:
          url: >-
            https://fr24.com/{{ trigger.event.data.callsign }}/{{
            trigger.event.data.id }}
          image: "{{ trigger.event.data.aircraft_photo_medium }}"

All available fields in trigger.event.data you can check here

If you have defined more than one device of FlightRadar24 for more places to observe - you may be interested to know what device has fired the event It is stored in

<a id="tracked_by_device">trigger.event.data.tracked_by_device</a>

To change name in tracked_by_device

1. Go to the <b>Settings</b>-><b>Devices & services</b>.
2. Search for Flightradar24, and click on it.
3. Click on three-dot near of device you wanted
4. Click on Rename in the opened sub-menu
5. Enter new name and click OK

<a id="notification-scheduled">Notification - When a tracked scheduled flight takes off</a>

To receive notification of taking off tracked scheduled flight add following lines to your configuration.yaml file:

automation:
  - alias: "Scheduled flight takes off"
    trigger:
      platform: event
      event_type: flightradar24_tracked_took_off
    action:
      service: notify.mobile_app_<device_name>
      data:
        message: >-
          Flight takes off {{ trigger.event.data.callsign }} to {{ trigger.event.data.airport_destination_city }}
          [Open FlightRadar](https://www.flightradar24.com/{{ trigger.event.data.callsign }})
        data:
          url: >-
            https://fr24.com/{{ trigger.event.data.callsign }}/{{
            trigger.event.data.id }}
          image: "{{ trigger.event.data.aircraft_photo_medium }}"

<a id="automation">Automation</a>

To automatically add a flight to additional tracking add following lines to your configuration.yaml file:

automation:
  - alias: "Track flights"
    trigger:
      platform: event
      event_type: flightradar24_exit
    condition:
      - condition: template
        value_template: "{{ 'Frankfurt' == trigger.event.data.airport_origin_city }}"
    action:
      - service: text.set_value
        data:
          value: "{{ trigger.event.data.aircraft_registration }}"
        target:
          entity_id: text.flightradar24_add_to_track

This is an example to filter flights to track, change the conditions for your needs

<a id="last-flights">Last Flights History Sensor</a>

You may get info for last flights which were in your area. Or get info about latest exited flight. Here is an example for recording history for the last 5 flights. The sensor has the same structure as sensor.flighradar24_current_in_area and so you can use the same markdown code. Only the sensor state is different - it shows the latest exited flight. You may change it for your needs. Add following lines to your configuration.yaml file:

template:
  - trigger:
      - platform: event
        event_type: flightradar24_exit

    sensor:
      - unique_id: flightradar24_last_5_flights
        name: "FlightRadar24 Last 5 Flights"
        state: >-
          {% set flight = trigger.event.data %}
          {{ flight.flight_number }} - {{ flight.airline_short }} - {{ flight.aircraft_model }} ({{ flight.aircraft_registration }})
          {{ flight.airport_origin_city }} > {{ flight.airport_destination_city }}
        attributes:
          flights: >-
            {% set n = 5 %}
            {% set m = this.attributes.flights | count | default(0) %}
            {{ [ trigger.event.data ] + 
               ( [] if m == 0 else 
                 this.attributes.flights[0:n-1] )
            }}
          icon: mdi:airplane

<a id="lovelace">Lovelace Card</a>

You can add flight table to your Home Assistant dashboard

1. Go to your Home Assistant dashboard
2. In the top right corner, select the three-dot menu, then select Edit dashboard
3. Click on + ADD CARD, search for Manual, click on Manual.
4. Add following code to the input window and click SAVE

type: vertical-stack
title: Flightradar24
cards:
  - type: entities
    entities:
      - entity: sensor.flightradar24_current_in_area
        name: In area
  - type: conditional
    conditions:
      - condition: numeric_state
        entity: sensor.flightradar24_current_in_area
        above: 0
    card:
      type: markdown
      content: >-
        {% set data = state_attr('sensor.flightradar24_current_in_area',
        'flights') %} {% for flight in data %}{% if (flight.tracked_type | default('live')) == 'live' %}
          <ha-icon icon="mdi:airplane"></ha-icon>{{ flight.flight_number }} - {{ flight.airline_short }} - {{ flight.aircraft_model }}
          {{ flight.airport_origin_city }}{%if flight.airport_origin_city %}<img src="https://flagsapi.com/{{ flight.airport_origin_country_code }}/shiny/16.png" title='{{ flight.airport_origin_country_name }}'/>{% endif %} -> {{ flight.airport_destination_city }}{%
          if flight.airport_destination_country_code %}<img src="https://flagsapi.com/{{ flight.airport_destination_country_code }}/shiny/16.png" title='{{ flight.airport_destination_country_name }}'/>{% endif %}
          {%if flight.time_scheduled_departure %}Departure - {{ flight.time_scheduled_departure | timestamp_custom('%H:%M') }}; {% endif %}{%if flight.time_scheduled_arrival%}Arrival - {{ flight.time_scheduled_arrival | timestamp_custom('%H:%M') }}{% endif %}
          Altitude - {{ flight.altitude }} ft{%if flight.altitude > 0 %} ({{(flight.altitude * 0.3048)| round(0)}} m){% endif%}; Gr. speed - {{ flight.ground_speed }} kts{%if flight.ground_speed > 0 %} ({{(flight.ground_speed * 1.852)| round(0)}} km/h){% endif%}
          {% else%}
          <ha-icon icon="mdi:airplane"></ha-icon>{{ flight.flight_number }} - {{ flight.callsign }} - {{ flight.tracked_type }}
          {% endif%}{% endfor %}

This example for sensor.flightradar24_current_in_area which shows flights in your area, to show additional tracked flights replace sensor name to sensor.flightradar24_additional_tracked

All available fields for flight you can check here

Lovelace Card with Map

1. Open in a browser https://www.flightradar24.com
2. Move the map so that your area is in the middle of the screen. And scroll to select comfortable map zoom
3. Now you have URL of the map like https://www.flightradar24.com/50.03,8.49/12 Remember this URL
4. Go to your Home Assistant dashboard
5. In the top right corner, select the three-dot menu, then select Edit dashboard
6. Click on + ADD CARD, search for Manual, click on Manual.
7. Add following code to the input window. Replace LATITUDE, LONGITUDE and ZOOM from URL from step 3. (Example - https://www.flightradar24.com/50.03,8.49/12 - LATITUDE is 50.03, LONGITUDE is 8.49, ZOOM is 12)
8. Click SAVE

type: vertical-stack
title: Flightradar24
cards:
  - type: entities
    entities:
      - entity: sensor.flightradar24_current_in_area
        name: In area
  - type: conditional
    conditions:
      - condition: numeric_state
        entity: sensor.flightradar24_current_in_area
        above: 0
    card:
      type: markdown
      content: >-
        {% set data = state_attr('sensor.flightradar24_current_in_area',
        'flights') %} {% for flight in data %}
          <ha-icon icon="mdi:airplane"></ha-icon>{{ flight.flight_number }}({{ flight.aircraft_registration }}) - {{ flight.airline_short }} - {{ flight.aircraft_model }}
          {{ flight.airport_origin_city }}{%if flight.airport_origin_city %}<img src="https://flagsapi.com/{{ flight.airport_origin_country_code }}/shiny/16.png" title='{{ flight.airport_origin_country_name }}'/>{% endif %} -> {{ flight.airport_destination_city }}{%
          if flight.airport_destination_country_code %}<img src="https://flagsapi.com/{{ flight.airport_destination_country_code }}/shiny/16.png" title='{{ flight.airport_destination_country_name }}'/>{% endif %}
          {%if flight.time_scheduled_departure %}Departure - {{ flight.time_scheduled_departure | timestamp_custom('%H:%M') }}; {% endif %}{%if flight.time_scheduled_arrival%}Arrival - {{ flight.time_scheduled_arrival | timestamp_custom('%H:%M') }}{% endif %}
          Altitude - {{ flight.altitude }} ft{%if flight.altitude > 0 %} ({{(flight.altitude * 0.3048)| round(0)}} m){% endif%}; Gr. speed - {{ flight.ground_speed }} kts{%if flight.ground_speed > 0 %} ({{(flight.ground_speed * 1.852)| round(0)}} km/h){% endif%}
          {% endfor %}
  - type: iframe
    url: >-
      https://www.flightradar24.com/simple?lat=LATITUDE&lon=LONGITUDE&z=ZOOM&label1=reg&size=small
    aspect_ratio: 100%

Database decrease

To decrease data stored by Recorder in database add following lines to your configuration.yaml file:

recorder:
  exclude:
    entity_globs:
      - sensor.flightradar24*

<a id="flight">Flight fields</a>

<a id="most-tracked">Most tracked</a>

Sensor Most tracked shows top 10 most tracked flights on FlightRadar24 with next flight fields

Thanks To

• FlightRadarAPI by @JeanExtreme002
• The OpenSky integration

This integration should only be used for your own educational purposes. If you are interested in accessing Flightradar24 data commercially, please contact business@fr24.com. See more information at Flightradar24's terms and conditions.