Add docs for Yahoo! Weather platform (#2782)

This commit is contained in:
Fabian Affolter 2017-06-07 10:50:06 +02:00 committed by GitHub
parent 098a6f522d
commit d7aeb18d37
2 changed files with 47 additions and 7 deletions

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Yahoo Weather"
title: "Yahoo Weather Sensor"
description: "Instructions how to integrate Yahoo Weather within Home Assistant."
date: 2016-07-06 9:06
sidebar: true
@ -16,10 +16,10 @@ ha_release: 0.24
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day. You can use only `weather`, `temp_min`, and `temp_max` with forecast. It's important to note that a yweather sensor will only show ONE days forecast at a time so to show multiple days forecasts, you will need to use the 'name:' option and give each sensor a unique name.
<p class='note warning'>
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2,000 signed calls per day.
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
</p>
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your woeid by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a woeid it generate it from Home Assistant's latitude and longitude.
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
@ -67,7 +67,6 @@ sensor:
- weather
- temp_min
- temp_max
- platform: yweather
forecast: 2
name: yw_day2
@ -75,7 +74,6 @@ sensor:
- weather
- temp_min
- temp_max
- platform: yweather
forecast: 3
name: yw_day3
@ -83,9 +81,7 @@ sensor:
- weather
- temp_min
- temp_max
```
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).

View File

@ -0,0 +1,44 @@
---
layout: page
title: "Yahoo Weather"
description: "Instructions how to integrate Yahoo Weather within Home Assistant."
date: 2016-07-06 9:06
sidebar: true
comments: false
sharing: true
footer: true
logo: yahooweather.png
ha_category: Weather
ha_release: 0.47
---
The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as an source for current meteorological data. The `forecast` will show you the condition for 5 days, 0 is the current day.
<p class='note warning'>
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
</p>
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
weather:
- platform: yweather
```
Configuration variables:
- **woeid** (*Optional*): See above.
- **forecast** (*Optional*): Day of forecast. The default is the current day to display conditions.
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. Defaults to `Yweather`.
<p class='note'>
This platform is an alternative to the [`yweather`](/components/sensor.yweather/) sensor.
</p>
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).