|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: GeoRSS Events Sensor |
| 4 | +description: "Instructions on how to set up GeoRSS sensors within Home Assistant." |
| 5 | +date: 2017-07-31 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: rss.png |
| 11 | +ha_category: Sensor |
| 12 | +ha_version: 0.55 |
| 13 | +ha_iot_class: "Cloud Polling" |
| 14 | +--- |
| 15 | + |
| 16 | +The `geo_rss_events` sensor retrieves events from a GeoRSS feed and |
| 17 | +shows information of those events filtered by distance to Home Assistant's |
| 18 | +location and grouped by category. |
| 19 | + |
| 20 | +This sensor is particularly useful if events occur unexpectedly in the |
| 21 | +vicinity of the home while the GeoRSS feed also contains many events |
| 22 | +representing distant unrelated entries. Typical examples are bush fires |
| 23 | +alerts or earthquakes. |
| 24 | + |
| 25 | +<p class='img'> |
| 26 | + <img src='{{site_root}}/images/screenshots/geo-rss-incidents-group-screenshot.png' /> |
| 27 | +</p> |
| 28 | + |
| 29 | +The reference point for comparing the distance is defined by `latitude` |
| 30 | +and `longitude` in the basic configuration. |
| 31 | + |
| 32 | +Only entries of the feed are considered that define a location as `point` |
| 33 | +or `polygon` in *georss.org* format or as *WGS84 latitude/longitude*. |
| 34 | + |
| 35 | +The data is updated every 5 minutes. |
| 36 | + |
| 37 | +## {% linkable_title Configuration %} |
| 38 | + |
| 39 | +To enable the GeoRSS events sensor, add the following lines to your |
| 40 | +`configuration.yaml`. This is an example configuration showing bush fire |
| 41 | +incidents from the NSW Rural Fire Service. |
| 42 | + |
| 43 | +```yaml |
| 44 | +# Example configuration.yaml entry |
| 45 | +sensor: |
| 46 | + - platform: geo_rss_events |
| 47 | + name: NSW Fire Service |
| 48 | + url: http://www.rfs.nsw.gov.au/feeds/majorIncidents.xml |
| 49 | + unit_of_measurement: 'Incidents' |
| 50 | + categories: |
| 51 | + - 'Emergency Warning' |
| 52 | + - 'Watch and Act' |
| 53 | + - 'Advice' |
| 54 | +``` |
| 55 | +
|
| 56 | +Configuration variables: |
| 57 | +
|
| 58 | +- **url** (*Required*): Full URL of the GeoRSS feed. |
| 59 | +- **name** (*Optional*): Name of the sensor used in generating the entity id. Default is 'Event Service'. |
| 60 | +- **radius** (*Optional*): The distance in kilometres around the Home Assistant's coordinates in which events are considered. Default is: 20km. |
| 61 | +- **categories** (*Optional*): List of event category names found in the GeoRSS feed. A separate sensor is created for each category defined. Default is to join events from all categories into an 'Any' category. |
| 62 | +- **unit_of_measurement** (*Optional*): The type of events found in the GeoRSS feed. Default is 'Events'. |
| 63 | +
|
| 64 | +## {% linkable_title Example Feeds %} |
| 65 | +
|
| 66 | +**Bush Fire Alerts** |
| 67 | +
|
| 68 | +```yaml |
| 69 | +sensor: |
| 70 | + - platform: geo_rss_events |
| 71 | + name: Qld Fire and Emergency Services |
| 72 | + url: https://www.qfes.qld.gov.au/data/alerts/bushfireAlert.xml |
| 73 | + unit_of_measurement: 'Alerts' |
| 74 | + - platform: geo_rss_events |
| 75 | + name: Tas Fire Service |
| 76 | + url: http://www.fire.tas.gov.au/Show?pageId=colBushfireSummariesRss |
| 77 | + unit_of_measurement: 'Alerts' |
| 78 | + - platform: geo_rss_events |
| 79 | + name: WA Department of Fire and Emergency Services |
| 80 | + url: https://www.emergency.wa.gov.au/data/incident_FCAD.rss |
| 81 | + - platform: geo_rss_events |
| 82 | + name: ACT Emergency Services Agency |
| 83 | + url: http://www.esa.act.gov.au/feeds/currentincidents.xml |
| 84 | +``` |
| 85 | +
|
| 86 | +
|
| 87 | +**Earthquake Alerts** |
| 88 | +
|
| 89 | +```yaml |
| 90 | +sensor: |
| 91 | + - platform: geo_rss_events |
| 92 | + name: USGS All Earthquakes |
| 93 | + url: https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_day.atom |
| 94 | + categories: |
| 95 | + - 'Past Hour' |
| 96 | + - 'Past Day' |
| 97 | + - platform: geo_rss_events |
| 98 | + name: BGS Worlwide Earthquakes |
| 99 | + url: http://www.bgs.ac.uk/feeds/worldSeismology.xml |
| 100 | + categories: |
| 101 | + - 'EQMH' |
| 102 | + - platform: geo_rss_events |
| 103 | + name: Recent significant earthquake reports (Canada) |
| 104 | + url: http://www.earthquakescanada.nrcan.gc.ca/index-en.php?tpl_region=canada&tpl_output=rss |
| 105 | + categories: |
| 106 | + - 'Earthquake Report' |
| 107 | +``` |
0 commit comments