From 352c6cb15a691a14223ce64d50123ff12d00c0ba Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 29 Sep 2016 10:55:31 +0200 Subject: [PATCH 1/3] Add initial docs for weather component --- source/_components/demo.markdown | 1 + source/_components/weather.markdown | 15 ++++++++ .../weather.openweathermap.markdown | 38 +++++++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 source/_components/weather.markdown create mode 100644 source/_components/weather.openweathermap.markdown diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index 3ed516f9147b..8d2698f4442e 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -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: diff --git a/source/_components/weather.markdown b/source/_components/weather.markdown new file mode 100644 index 000000000000..784c917048f7 --- /dev/null +++ b/source/_components/weather.markdown @@ -0,0 +1,15 @@ +--- +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 +--- + +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 a free web services and such which requires a registration. Please check the sidebar for a full list of supported sensor platforms. + diff --git a/source/_components/weather.openweathermap.markdown b/source/_components/weather.openweathermap.markdown new file mode 100644 index 000000000000..9a870b613413 --- /dev/null +++ b/source/_components/weather.openweathermap.markdown @@ -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.30" +--- + + +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. + +Details about the API are available in the [OpenWeatherMap documentation](http://openweathermap.org/api). + From 50afae10bf94c4dfd25d60a2d9223e2dd010fb7c Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 25 Oct 2016 08:55:14 +0200 Subject: [PATCH 2/3] Fix typo --- source/_components/weather.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/_components/weather.markdown b/source/_components/weather.markdown index 784c917048f7..cb6b290d2787 100644 --- a/source/_components/weather.markdown +++ b/source/_components/weather.markdown @@ -9,7 +9,8 @@ sharing: true footer: true --- -Weather platforms are gathering meteorological information from web services and displays the conditions and other details about the weather at the given location. +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. -Home Assistant currently supports a free web services and such which requires a registration. Please check the sidebar for a full list of supported sensor platforms. From b735a81a35248380b2f4a8e53a56a13a1da84ddd Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 25 Oct 2016 08:55:28 +0200 Subject: [PATCH 3/3] Add note --- source/_components/weather.openweathermap.markdown | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/weather.openweathermap.markdown b/source/_components/weather.openweathermap.markdown index 9a870b613413..0fe9383d56a4 100644 --- a/source/_components/weather.openweathermap.markdown +++ b/source/_components/weather.openweathermap.markdown @@ -9,10 +9,9 @@ sharing: true footer: true logo: openweathermap.png ha_category: Weather -ha_release: "0.30" +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). @@ -34,5 +33,6 @@ Configuration variables: - **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. -Details about the API are available in the [OpenWeatherMap documentation](http://openweathermap.org/api). - +

+This platform is an alternative to the [`openweathermap`](/components/sensor.openweathermap/) sensor. +