diff --git a/source/_components/geo_location.geo_json_events.markdown b/source/_components/geo_location.geo_json_events.markdown new file mode 100644 index 00000000000..3be0ccc2fb2 --- /dev/null +++ b/source/_components/geo_location.geo_json_events.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "GeoJSON Events" +description: "Instructions on how to integrate GeoJSON feeds into Home Assistant." +date: 2018-09-19 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: geo_location.png +ha_category: Geo Location +ha_iot_class: "Cloud Polling" +ha_release: "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](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php). + +```yaml +# 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`](/docs/configuration/platform_options/#entity-namespace/) for each platform which will prefix each entity ID with the defined value. + +```yaml +# 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' +``` diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index 2990c019514..c77243971a8 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Other +logo: geo_location.png ha_release: "0.78" --- diff --git a/source/images/supported_brands/geo_location.png b/source/images/supported_brands/geo_location.png new file mode 100644 index 00000000000..a8fab0f9133 Binary files /dev/null and b/source/images/supported_brands/geo_location.png differ