Skip to content

Latest commit

 

History

History
88 lines (71 loc) · 3.09 KB

README.md

File metadata and controls

88 lines (71 loc) · 3.09 KB
Raw
title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type
OpenSky Network
Instructions on how to integrate OpenSky Network into Home Assistant.
Transport
0.43
Cloud Polling
opensky
sensor
integration

The opensky sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the OpenSky Network public API. It will also fire Home Assistant events when flights enter and exit the defined region.

Installation

To install this sensor, copy the files from this repo to YOUR_HA_INSTANCE/config/custom_components/opensky

Configuration

To enable this sensor, add the following lines to your configuration.yaml file:

sensor:
  - platform: opensky
    radius: 10
    username: opensky-username
    password: abc123

Configuration options for the OpenSky Network sensor:

  • radius (Required): Radius of region to monitor, in kilometers. If this value exceeds approximately 250 then eventually the API limit will be exceeded, the sensor will stop working and errors will be noted in the logs until the day resets. See https://openskynetwork.github.io/opensky-api/rest.html#api-credit-usage
  • username (Required): Your Opensky-Network username.
  • password (Required): Your Opensky-Network password.
  • latitude (Optional): Region latitude. Defaults to home zone latitude.
  • longitude (Optional): Region longitude. Defaults to home zone longitude.
  • altitude (Optional): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0).
  • name (Optional): Sensor name. Defaults to opensky.

Events

  • opensky_entry: Fired when a flight enters the region.
  • opensky_exit: Fired when a flight exits the region.

Both events have four attributes:

  • sensor: Name of opensky sensor that fired the event.
  • callsign: Callsign of the flight.
  • altitude: Altitude of the flight in meters.
  • icao24: The ICAO 24-bit address of the aircraft's transponder.

To receive notifications of the entering flights using the Home Assistant Companion App, add the following lines to your configuration.yaml file:

automation:
  - alias: "Flight entry notification"
    trigger:
      platform: event
      event_type: opensky_entry
    action:
      service: notify.mobile_app_<device_name>
      data:
        message: "Flight entry of {{ trigger.event.data.callsign }}"

One can also get a direct link to the OpenSky website to see the flight using the icao24 identification:

automation:
  - alias: "Flight entry notification"
    trigger:
      platform: event
      event_type: opensky_entry
    action:
      service: notify.mobile_app_<device_name>
      data:
        message: "Flight entry of {{ trigger.event.data.callsign }}"
        data:
          actions:
            - action: URI
              title: Track the flight
              uri: >-
                https://opensky-network.org/aircraft-profile?icao24={{
                trigger.event.data.icao24 }}