Merge pull request #1001 from fabaff/weather-component

Add docs for Weather component
This commit is contained in:
Fabian Affolter 2016-10-25 08:55:51 +02:00 committed by GitHub
commit 3538b853d9
3 changed files with 55 additions and 0 deletions

View File

@ -27,6 +27,7 @@ Available demo platforms:
- [Notification](/components/notify/) (`notify`)
- [Sensor](/components/sensor/) (`sensor`)
- [Switch](/components/switch/) (`switch`)
- [Weather](/components/weather/) (`weather`)
To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file:

View File

@ -0,0 +1,16 @@
---
layout: page
title: "Weather"
description: "Instructions how to setup your Weather platforms with Home Assistant."
date: 2016-09-28 14:00
sidebar: true
comments: false
sharing: true
footer: true
---
The `weather` platforms are gathering meteorological information from web services and displays the conditions and other details about the weather at the given location.
Home Assistant currently supports free web services and such which requires a registration. Please check the sidebar for a full list of supported `weather` platforms.

View File

@ -0,0 +1,38 @@
---
layout: page
title: "OpenWeatherMap"
description: "Instructions how to integrate OpenWeatherMap within Home Assistant."
date: 2016-09-29 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: openweathermap.png
ha_category: Weather
ha_release: 0.32
---
The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as an source for current meteorological data for your location.
You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up).
To add OpenWeatherMap to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
weather:
- platform: openweathermap
api_key: YOUR_API_KEY
latitude: 46.1234
longitude: 7.1234
```
Configuration variables:
- **api_key** (*Required*): Your API key for http://openweathermap.org/.
- **latitude** (*Optional*): Latitude of the location to display the weather. Defaults to the latitude in your your `configuration.yaml` file.
- **longitude** (*Optional*): Longitude of the location to display the weather. Defaults to the longitude in your `configuration.yaml` file.
<p class='note'>
This platform is an alternative to the [`openweathermap`](/components/sensor.openweathermap/) sensor.
</p>