Repository files navigation

A custom card for Home Assistant to list the aircraft found in theDump1090 output of your ADS-B/Mode S receiver.

This card is developed and tested based on the output ofdata/aircraft.json of theFlightRadar24 Pi24 image.

The FR24 card has many configuration options and supports multiple languages.

Did my project help you? Then you can always thank me with a coffee!

Contents of this file

• Lovelace FR24 card
• Preparation
• Installation
• Add the card to your dashboard
• Configuration
  • Colors
  • Columns
  • Hide
    • Hide empty values
• F.A.Q.
• Contribute
• Credits

To use the card you need to create a sensor that reads the JSON from Dump1090. Add the following configuration to yoursensors.yaml:

-platform:restname:FR24 Aircraftresource:http://dump1090-host/dump1090/data/aircraft.jsonvalue_template:"{{ value_json.messages }}"method:GETscan_interval:15json_attributes:    -now    -aircraft

Update the keyresource in this configuration to the correct URL of your Dump1090 output. Thescan_interval of 15 seconds is a suggestion, you can change this in any other value. But keep in mind that a lower interval results in a higher load on your Home Assistant environment.

After adding the sensor you need to restart Home Assistant. After restarting, in the Developer Tools check if the sensor has data.

Install usingHACS, or followthese instructions.

The card can be added to your dashboard like any other card. If you do not see the card as an option, clear the cache of your browser and try again.

The minimal configuration of the card contains only the entity of the sensor. When using the sensor from the above example, the card can be added with the following configuration:

type:custom:fr24-cardentity:sensor.fr24_aircraft

All options can be added in the configuration of the card, eg:

type:custom:fr24-cardentity:sensor.fr24_aircraftlang:nlsort:track

The following configuration options are available:

Option	Type	Default	Accepted	Description
attribute	string	aircraft	An attribute of the sensor	By default the card will read the aircrafts from the sensorsaircraft attribute. If your sensor uses a different attribute, change this value to the name of your attribute.
colors	object			Used to overwrite the default color scheme of the card. SeeColors.
columns	array	["flag", "registration", "flight", "altitude", "speed", "distance", "track"]	Array with any of the columns, seecolumns	Array containing the columns to show in the table. The data of the other columns is available in the popup, if that is enabled. Too many columns will break your Dashboard, so the card will give a warning if too many columns are added.
hide	object			Used to configure which data is hidden. SeeHide.
lang	string	null	Any supported language, see thelang folder	Sets the display language of the data. By default thehass object of your browser will be used to set the language. If that language is not available, English will be used. The registered country is always in English.
larger_units	boolean	false	true,false	When usingmetric units, and this option set totrue, the units are converted tokm for altitude and distance andkm/h for speed.
limit	number	null	A positive integer	Used to limit the number of results in the table.
order	string	asc	asc,desc	Sort order of the data. Ascending (asc, smallest value first) or descending (desc, largest value first).
popup	boolean	false	true,false	Enables or disables the popup. The popup requires bothbrowser_mod andcard-mod]. The popup can be opened by clicking on a row and contains more data of the aircraft, including a photo of the aircraft provided byPlanespotters.net.
sort	string	altitude	Any column, seecolumns	The data in the table is by default sorted on the altitude, with this option you can set a different column, for exampleflight.
title	string	null		Title of the card.
track_in_text	boolean	false	true,false	By default the reported track of the aircraft is displayd in degrees°. With this option set totrue the track is displayed in text. When displayed in text, it's an abbreviation in the table and full text in the popup.
units_in_table	boolean	false	true,false	When this option is set totrue, the table header will be appended with a second row containing the units.
units	string	default	default,metric	Sets the units for the values. Thedefault units are as they are returned by Dump1090 (ft for altitude,NM for distance,kt for speed). When usingmetric the value and units are converted (m for altitude and distance,m/s for speed).
zone	string	null	Any sensor that is a zone, examplezone.home	The distance between Home Assistant and the reported position of the aircraft is calculated using the position of a zone. If you don't set azone the data doesn't have the distance.

By default the card uses the primairy and secondairy colors of the active color scheme. In some cases this might lead to unwanted results. Using thecolors object in the configuration of the card it's possible to overwrite the colors of both the table in the card and the popup.

The colors can be added as values that are accepted by CSS: HEX code (which must be enclosed by single quotes), RGB value, named color or a CSS variable. Example:

type:custom:fr24-cardentity:sensor.fr24_aircraftcolors:table_head_bg:var(--primary-color)table_head_text:yellowtable_units_bg:rgb(187,78,123)table_units_text:'#00ff00'

With this option you can really go creative and make theugliest most original creations. The following options are available:

The card supports the following columns. Because there are many different formats of output of the Dump1090 (or Tar1090) data, not all columns are arvailable for each installation.

All of the columns, except foricon are shown in the popup.

With this object it's possible to set the configuration of the data that is hidden. Data must be added as an object in the yaml configuration. Example:

type:custom:fr24-cardentity:sensor.fr24_aircrafthide:old_messages:false

The following keys are available in the object:

With the optionhide.empty it's possible to remove empty values from the table.

Example to remove all rows where there is no distance:

type:custom:fr24-cardentity:sensor.fr24_aircrafthide:empty:    -distance

Example to remove all rows where there is no distanceor track:

type:custom:fr24-cardentity:sensor.fr24_aircrafthide:empty:    -distance    -track

Please read ourF.A.Q. before opening an issue.

You can help improving this card by forking this repository and merging your changes with a pull request to thedevelop branch of this repository.

This applies not only to additions and improvements to the code, but certainly also to newlanguages.

I am particularly interested in improvements to the registration code database. For more information about the database, clickhere.

Honor where credit is due. This card could not have been made without consulting the following sources:

• The aircraft registration and country data is heavily inspired on the code fromFlightAware's Dump1090;
• The popup is working thanks to the excellent plugins by Thomas Lovén:browser_mod andcard-mod;
• The aircraft photos in the popup are added with the use of thePlanespotters.net API.