Additional information for Geolocation platforms (#8113)

* fixed wrong type

* added missing source to the attributes table

* added state attributes table

* radius default corrected to float value
This commit is contained in:
Malte Franken 2019-01-15 08:58:55 +11:00 committed by Franck Nijhof
parent 350004c3ce
commit aedc489978
3 changed files with 16 additions and 4 deletions

View File

@ -39,8 +39,8 @@ url:
radius:
description: The distance in kilometers around the Home Assistant's coordinates in which events are considered.
required: false
type: string
default: 20km
type: float
default: 20.0
latitude:
description: Latitude of the coordinates around which events are considered.
required: false
@ -53,6 +53,17 @@ longitude:
default: Longitude defined in your `configuration.yaml`
{% 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 event. |
| longitude | Longitude of the event. |
| source | `geo_json_events` to be used in conjunction with `geo_location` automation trigger. |
| external_id | The external ID used in the feed to identify the event in the feed. |
## {% 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.

View File

@ -44,7 +44,7 @@ radius:
description: The distance in kilometers around Home Assistant's coordinates in which incidents are included.
required: false
type: float
default: 20km
default: 20.0
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
@ -70,6 +70,7 @@ The following state attributes are available for each entity in addition to the
|--------------------|-------------|
| latitude | Latitude of the incident. |
| longitude | Longitude of the incident. |
| source | `nsw_rural_fire_service_feed` to be used in conjunction with `geo_location` automation trigger. |
| 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. |

View File

@ -52,7 +52,7 @@ radius:
description: The distance in kilometers around Home Assistant's coordinates in which seismic events are included.
required: false
type: float
default: 50
default: 50.0
latitude:
description: Latitude of the coordinates around which events are considered.
required: false