mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-26 03:56:50 +00:00
f8202c1a3e
* Update attribute
Update `device tracker` attribute to reflect changes in iOS app with release of 2.0/2019
* Change known_devices.yaml example explanation
iOS App 2.0/2019 no long users `known_devices.yaml` so change explanation of example to something that does.
Reword
* Update notification example
Update example automation to reflect changes in in ios app (now used cross-platform domain `mobile_app`)
* Update to reference companion apps
The simplest solution to get battery level is with the companion apps so this should be made clear.
* Add android
We have an android app now 🎉
57 lines
1.9 KiB
Markdown
57 lines
1.9 KiB
Markdown
---
|
|
title: "OpenSky Network"
|
|
description: "Instructions on how to integrate OpenSky Network into Home Assistant."
|
|
logo: opensky.png
|
|
ha_category:
|
|
- Transport
|
|
ha_release: 0.43
|
|
ha_iot_class: Cloud Polling
|
|
---
|
|
|
|
The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region.
|
|
|
|
## Configuration
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
sensor:
|
|
- platform: opensky
|
|
radius: 10
|
|
```
|
|
|
|
Configuration options for the OpenSky Network sensor:
|
|
|
|
- **radius** (*Required*): Radius of region to monitor, in kilometers.
|
|
- **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 three attributes:
|
|
|
|
- **sensor**: Name of `opensky` sensor that fired the event.
|
|
- **callsign**: Callsign of the flight.
|
|
- **altitude**: Altitude of the flight in meters.
|
|
|
|
To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your `configuration.yaml` file:
|
|
|
|
{% raw %}
|
|
```yaml
|
|
automation:
|
|
- alias: 'Flight entry notification'
|
|
trigger:
|
|
platform: event
|
|
event_type: opensky_entry
|
|
action:
|
|
service: notify.mobile_app_<device_name>
|
|
data_template:
|
|
message : 'Flight entry of {{ trigger.event.data.callsign }} '
|
|
```
|
|
{% endraw %}
|