Queensland bushfire alert feed platform (#9623)

* documenting new qld_bushfire platform

* added note about creative commons license

* made small changes after review
This commit is contained in:
Malte Franken 2019-06-20 00:19:13 +10:00 committed by Franck Nijhof
parent 2f25f8e6cf
commit 4de9b5d1de
3 changed files with 103 additions and 0 deletions

View File

@ -24,6 +24,7 @@ The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be
| GeoJSON Events | `geo_json_events` |
| IGN Sismología | `ign_sismologia` |
| NSW Rural Fire Service Incidents | `nsw_rural_fire_service_feed` |
| Queensland Bushfire Alert | `qld_bushfire` |
| U.S. Geological Survey Earthquake Hazards Program | `usgs_earthquakes_feed` |
Conditions can be used to further filter entities, for example by inspecting their state attributes.

View File

@ -0,0 +1,102 @@
---
layout: page
title: "Queensland Bushfire Alert"
description: "Instructions on how to integrate the Queensland Bushfire Alert feed into Home Assistant."
date: 2019-06-11 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: geo_location.png
ha_category: Geolocation
ha_iot_class: Cloud Polling
ha_release: 0.95
---
The `qld_bushfire` platform lets you integrate a
[GeoRSS feed](https://www.ruralfire.qld.gov.au/map/Pages/default.aspx)
containing bushfire alerts for Queensland. It retrieves alerts from a feed
and shows information of those alerts filtered by distance to Home Assistant's
location.
Entities are generated, updated and removed automatically with each update
from the feed. Each entity defines latitude and longitude and will be shown
on the default map automatically, or on a map card by defining the source
`qld_bushfire`. The distance in kilometers is available as the state
of each entity.
<p class='img'>
<img src='{{site_root}}/images/screenshots/qld-bushfire-feed-map.png' />
</p>
The data is updated every 5 minutes.
<p class='note'>
The material used by this integration is provided under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode).
It has only been modified for the purpose of presenting the material in Home Assistant.
Please refer to the [creator's copyright notice](https://www.qfes.qld.gov.au/Pages/copyright.aspx) for more information.
</p>
## {% linkable_title Configuration %}
To integrate the Queensland Bushfire Alert feed, add the following lines to
your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
geo_location:
- platform: qld_bushfire
```
{% configuration %}
categories:
description: List of category names found in the feed. Only alerts from the feed that match any of these categories are included. Valid categories are 'Emergency Warning', 'Watch and Act', 'Advice', 'Notification' and 'Information'.
required: false
type: list
radius:
description: The distance in kilometers around Home Assistant's coordinates in which bushfire alerts are included.
required: false
type: float
default: 20.0
latitude:
description: Latitude of the coordinates around which events are considered.
required: false
type: string
default: Latitude defined in your configuration
longitude:
description: Longitude of the coordinates around which events are considered.
required: false
type: string
default: Longitude defined in your configuration
{% endconfiguration %}
## {% linkable_title State Attributes %}
The following state attributes are available for each entity in addition to
the standard ones:
| Attribute | Description |
|------------------|-------------|
| latitude | Latitude of the bushfire alert. |
| longitude | Longitude of the bushfire alert. |
| source | `qld_bushfire` to be used in conjunction with `geo_location` automation trigger. |
| external_id | The external ID used in the feed to identify the bushfire alert in the feed. |
| title | Original title from the feed. |
| publication_date | Date and time when this alert was first published. |
| updated_date | Date and time when this alert was last updated. |
| status | Status of the alert, for example, "Patrolled", "Going", "Contained" |
## {% linkable_title Full Configuration %}
```yaml
# Example configuration.yaml entry
geo_location:
- platform: qld_bushfire
radius: 30
categories:
- 'Emergency Warning'
- 'Watch and Act'
latitude: -24.85
longitude: 152.35
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB