Update docs for refactored ISS integration (#21347)

This commit is contained in:
Simon Hansen 2022-02-14 21:09:05 +01:00 committed by GitHub
parent 397e184b39
commit ee7b0c1f50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -8,6 +8,8 @@ ha_release: 0.36
ha_domain: iss
ha_platforms:
- binary_sensor
ha_codeowners:
- '@DurgNomis-drol'
---
The `iss` platform uses the
@ -18,33 +20,13 @@ This means that ISS is 10° above the horizon of your home.
You can check in the attributes of the sensor to see the timestamp for the next
rise of the station, its current coordinates, and the number of people in space.
## Configuration
To add ISS binary sensor to your installation,
add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: iss
```
{% configuration %}
name:
description: The name for this sensor in the frontend.
required: false
type: string
default: ISS
show_on_map:
description: Option to show the position of the ISS on the map.
required: false
type: boolean
default: false
{% endconfiguration %}
{% include integrations/config_flow.md %}
<div class='note warning'>
If you set `show_on_map: true` then the location attributes are named `latitude` and `longitude`.
The default name of the location attributes is `lat` and `long` to avoid showing them on the map.
If you enable "Show on map" in the options for this integration then the location attributes
are named `latitude` and `longitude`. The default name of the location attributes is
`lat` and `long` to avoid showing them on the map.
</div>