a114c7fa9b
* new geo json platform for the geo location component * added iot class; removed `scan_interval` and mention default in the description instead
2.3 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_iot_class | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | GeoJSON Events | Instructions on how to integrate GeoJSON feeds into Home Assistant. | 2018-09-19 08:00 | true | false | true | true | geo_location.png | Geo Location | Cloud Polling | 0.79 |
The geo_json_events platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location.
All entries in the GeoJSON feed must define a geometry which typically is a point or polygon with geo coordinates. In addition, this platform will look for a title key in the entry's properties and use that as the entity's name.
Entities are generated, updated and removed automatically with each update from the GeoJSON feed. Each entity defines latitude and longitude and will be shown on the map automatically. The distance in kilometers is available as the state of each entity.
The data is updated every 5 minutes.
{% linkable_title Configuration %}
To integrate a GeoJSON feed, add the following lines to your configuration.yaml. This is an example configuration showing earthquake data provided by the U.S. Geological Survey.
# Example configuration.yaml entry
geo_location:
- platform: geo_json_events
url: https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.geojson
{% configuration %} url: description: Full URL of the GeoJSON feed. required: true type: string radius: description: The distance in kilometers around the Home Assistant's coordinates in which events are considered. required: false type: string default: 20km {% endconfiguration %}
{% linkable_title Advanced Configuration Example %}
When integrating several GeoJSON feeds, it may be useful to distinguish the entities of different feeds. The easiest way to do that is by defining an entity_namespace for each platform which will prefix each entity ID with the defined value.
# Example configuration.yaml entry
geo_location:
- platform: geo_json_events
url: https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.geojson
radius: 250
entity_namespace: 'usgs_earthquakes'