Skip to content

Add docs for Weather component #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 25, 2016
Merged

Add docs for Weather component #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
352c6cb
Add initial docs for weather component
fabaff Sep 29, 2016
50afae1
Fix typo
fabaff Oct 25, 2016
b735a81
Add note
fabaff Oct 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/_components/demo.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
16 changes: 16 additions & 0 deletions source/_components/weather.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.


38 changes: 38 additions & 0 deletions source/_components/weather.openweathermap.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>