diff --git a/source/_integrations/gdacs.markdown b/source/_integrations/gdacs.markdown new file mode 100644 index 00000000000..e603ff3aab8 --- /dev/null +++ b/source/_integrations/gdacs.markdown @@ -0,0 +1,136 @@ +--- +title: Global Disaster Alert and Coordination System (GDACS) +description: Instructions on how to integrate the Global Disaster Alert and Coordination System (GDACS) feed into Home Assistant. +logo: gdacs.jpg +ha_category: + - Geolocation +ha_iot_class: Cloud Polling +ha_release: 0.106 +ha_config_flow: true +ha_quality_scale: platinum +ha_codeowners: + - '@exxamalte' +--- + +The `gdacs` integration lets you use a GeoRSS feed provided by +[GDACS](https://www.gdacs.org/) with information +about major droughts, earthquakes, floods, tropical cyclones, tsunamis and +volcanic activities worldwide. +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 +`gdacs`. The distance is available as the state of each entity, and +converted to the unit (kilometers or miles) configured in Home Assistant. + +

+ +

+ +The data is updated every 5 minutes. + +
+ +The material used by this integration is provided by the [Global Disaster +Alert and Coordination System (GDACS)](https://www.gdacs.org/) - a cooperation +framework between the United Nations and the European Commission - under the +[Creative Commons Attribution 4.0 International (CC BY 4.0) licence](http://creativecommons.org/licenses/by/4.0/). +It has only been modified for the purpose of presenting the material in Home Assistant. +Please refer to the [creator's disclaimer and terms of use notice](https://www.gdacs.org/About/termofuse.aspx) for more information. + +
+ +## Configuration + +To integrate the GDACS feed use the "Integrations" feature +in the GUI, you find it under Configurations - Integrations, or add the +following line to your `configuration.yaml`. + +```yaml +# Example configuration.yaml entry +gdacs: +``` + +{% configuration %} +categories: + description: The categories of alerts to be included. Valid categories are 'Drought', 'Earthquake', 'Flood', 'Tropical Cyclone', 'Tsunami', 'Volcano'. + required: false + type: list +radius: + description: The radius around your location to monitor; defaults to 500 km or mi (depending on the unit system defined in your `configuration.yaml`). + required: false + type: float + default: 500.0 +latitude: + description: Latitude of the coordinates around which alerts are considered. + required: false + type: float + default: Latitude defined in your configuration. +longitude: + description: Longitude of the coordinates around which alerts are considered. + required: false + type: float + default: Longitude defined in your configuration. +{% endconfiguration %} + +## State Attributes + +The following state attributes are available for each entity in addition to +the standard ones: + +| Attribute | Description | +|------------------|-------------| +| latitude | Latitude of the alert's location. | +| longitude | Longitude of the alert's location. | +| source | `gdacs` to be used in conjunction with `geo_location` automation trigger. | +| external_id | The external ID used in the feed to identify the alert. | +| title | Title of this entry. | +| description | Description of this entry. | +| event type | Type of event this alert is for (Drought, Earthquake, Flood, Tropical Cyclone, Tsunami, Volcano). | +| alert level | Alert level (Red, Orange, Green). | +| country | Country that the alert is applicable to. | +| duration in week | Duration of the alert in full weeks (only shown if more than one week). | +| from date | Date and time this alert started. | +| to date | Date and time this alert ended (or now if ongoing). | +| population | Exposed population. | +| severity | Severity of the alert. | +| vulnerability | Vulnerability score (textual or numerical). | + +Please note that some of the attribute values depend on the context and may not +be comparable between different event types. + +## Sensor + +This integration automatically creates a sensor that shows how many entities +are currently managed by this integration. In addition to that the sensor has +some useful attributes that indicate the currentness of the data retrieved +from the feed. + +

+ +

+ +| Attribute | Description | +|------------------------|-------------| +| status | Status of last update from the feed ("OK" or "ERROR"). | +| last update | Timestamp of the last update from the feed. | +| last update successful | Timestamp of the last successful update from the feed. | +| last timestamp | Timestamp of the latest entry from the feed. | +| created | Number of entities that were created during last update (optional). | +| updated | Number of entities that were updated during last update (optional). | +| removed | Number of entities that were removed during last update (optional). | + +## Full Configuration + +```yaml +# Example configuration.yaml entry +gdacs: + categories: + - Drought + - Earthquake + radius: 1000 + latitude: -41.2 + longitude: 174.7 +``` diff --git a/source/_integrations/geo_location.markdown b/source/_integrations/geo_location.markdown index 2b020ba1974..81ae7364baf 100644 --- a/source/_integrations/geo_location.markdown +++ b/source/_integrations/geo_location.markdown @@ -13,15 +13,16 @@ Entities can have associated geolocation coordinates (latitude and longitude) so The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be used in automations triggered by Geolocation entities appearing in or disappearing from zones. The following value must be used as `source` of the trigger depending on which platform is managing the entities: -| Platform | Source | -|---------------------------------------------------|-------------------------------| -| GeoJSON Events | `geo_json_events` | -| GeoNet New Zealand Quakes | `geonetnz_quakes` | -| 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` | -| The World Wide Lightning Location Network | `wwlln` | +| Platform | Source | +|-------------------------------------------------------|-------------------------------| +| GeoJSON Events | `geo_json_events` | +| GeoNet New Zealand Quakes | `geonetnz_quakes` | +| Global Disaster Alert and Coordination System (GDACS) | `gdacs` | +| 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` | +| The World Wide Lightning Location Network | `wwlln` | Conditions can be used to further filter entities, for example by inspecting their state attributes. diff --git a/source/images/screenshots/gdacs-alerts-feed-map.png b/source/images/screenshots/gdacs-alerts-feed-map.png new file mode 100644 index 00000000000..906f8b8f515 Binary files /dev/null and b/source/images/screenshots/gdacs-alerts-feed-map.png differ diff --git a/source/images/screenshots/gdacs-alerts-sensor.png b/source/images/screenshots/gdacs-alerts-sensor.png new file mode 100644 index 00000000000..ff00f6e8cba Binary files /dev/null and b/source/images/screenshots/gdacs-alerts-sensor.png differ diff --git a/source/images/supported_brands/gdacs.jpg b/source/images/supported_brands/gdacs.jpg new file mode 100644 index 00000000000..0d63b968dea Binary files /dev/null and b/source/images/supported_brands/gdacs.jpg differ