jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-13 12:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Aurora documentation to reflect fixes and addition of config_flow. (#15598)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
djtimca 2020-11-11 15:29:33 -05:00 committed by GitHub
parent eaa586c062
commit 9a0e9f80b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
source/_integrations/aurora.markdown
View File

@ -16,31 +16,18 @@ You can check the attributes of the sensor to see your exact forecast.
## Configuration
To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file:
To add the aurora binary sensor to your installation, search for the Aurora integration through the Configuration -> Integrations menu.
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: aurora
```
Enter a name for your Aurora location as well as the longitude and latitude of the location (default to your Home Assistant location).
{% configuration %}
forecast_threshold:
description: Provide your own threshold number above which the sensor will trigger.
required: false
type: integer
default: 75
name:
description: The name of the sensor.
required: false
type: string
default: Aurora Visibility
{% endconfiguration %}
Click Submit to add the integration to your environment.
## Full example
You can configure multiple locations by adding the integration multiple times.
```yaml
binary_sensor:
- platform: aurora
forecast_threshold: 50
```
## Options
Once installed you can adjust the threshold for this location by clicking on the Options link on the integration.
## Sensors
The integration will add a single binary sensor for each location you configure which will be in the state on when there is a forecast probability of Aurora viewing above your threshold and off when it is below your selected threshold.