NSW Rural Fire Service platform (#6353)

* new platform to integrate nsw rural fire service incident feed for the geo location component

* added NSW Rural Fire Service crest

* final touches and integration of logo

* updated release number; correct type for radius
This commit is contained in:
Malte Franken 2018-10-15 03:36:00 +11:00 committed by Franck Nijhof
parent 2dbbafef62
commit f381ba7e34
4 changed files with 88 additions and 0 deletions

View File

@ -0,0 +1,88 @@
---
layout: page
title: "NSW Rural Fire Service Incidents"
description: "Instructions on how to integrate the NSW Rural Fire Service Incidents feed into Home Assistant."
date: 2018-09-23 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nsw-rural-fire-service.png
ha_category: Geo Location
ha_iot_class: "Cloud Polling"
ha_release: "0.81"
---
The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location.
<p class='img'>
<img src='{{site_root}}/images/screenshots/nsw-rural-fire-service-feed-entities.png' />
</p>
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 map automatically. The distance in kilometers is available as the state of each entity.
<p class='img'>
<img src='{{site_root}}/images/screenshots/nsw-rural-fire-service-feed-map.png' />
</p>
The entity's information can be used for example if a bush fire that produces smoke or embers is reported close to your home, and you want to automatically close windows, turn on a sprinkler system or simply send yourself a reminder to clean the gutters from dry leaves.
The data is updated every 5 minutes.
## {% linkable_title Configuration %}
To integrate the NSW Rural Fire Service Incidents feed, add the following lines to your `configuration.yaml`.
```yaml
# Example configuration.yaml entry
geo_location:
- platform: nsw_rural_fire_service_feed
```
{% configuration %}
radius:
description: The distance in kilometers around Home Assistant's coordinates in which incidents are included.
required: false
type: float
default: 20km
categories:
description: List of incident category names found in the feed. Only incidents from the feed that match any of these categories are included. Valid categories are 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'.
required: false
type: list
default: None. Any incident regardless of its category will be included.
{% 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 incident. |
| longitude | Longitude of the incident. |
| external_id | The external ID used in the feed to identify the incident in the feed. |
| category | One of 'Emergency Warning', 'Watch and Act', 'Advice', 'Not Applicable'. |
| location | Location details of where the incident takes place. |
| publication_date | Date and time when this incident was last updated. |
| council_area | Council area in which this incident takes place. |
| status | One of 'Under Control', 'Being Controlled', 'Out of Control'. |
| type | Incident type, for example 'Bush Fire', 'Grass Fire' or 'Hazard Reduction'. |
| fire | `True` if this incident is a fire, `False` otherwise. |
| size | Size in hectare |
| responsible_agency | Agency responsible for this incident. |
## {% linkable_title Advanced Configuration Example %}
Depending on your personal circumstances with regards to bush fire risk you may want to adjust the radius and define the categories of fire warnings you are actually interested in.
```yaml
# Example configuration.yaml entry
geo_location:
- platform: nsw_rural_fire_service_feed
entity_namespace: 'nsw_fire_service_feed'
radius: 10
categories:
- 'Emergency Warning'
- 'Watch and Act'
- 'Advice'
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB