Documentation for Buienradar sensor- and weather-component#2638
Conversation
fabaff
added
the
new-integration
Landrash
left a comment
Landrash
left a comment
There was a problem hiding this comment.
Some minor feedback but looks good in general 😸
| @@ -0,0 +1,86 @@ | |||
| --- | |||
| layout: page | |||
| title: "buienradar" | |||
|
|
||
| The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as an source for current meteorological data for your location. The | ||
| weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. | ||
| The relevant weatherstation used will be automatically selected based on the location specified in the HA config (or in the buienradar weather/sensor component). |
There was a problem hiding this comment.
Avoid the use of HA and instead write out the full name of Home Assistant. Similarly config should be configuration.
| weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. | ||
| The relevant weatherstation used will be automatically selected based on the location specified in the HA config (or in the buienradar weather/sensor component). | ||
|
|
||
| To add the buienradar sensor to your installation, add the following to your `configuration.yaml` file: |
There was a problem hiding this comment.
Suggest rephrasing this to
To integrate an
buienradarwith Home Assistant, add the following section to yourconfiguration.yamlfile:
| - **precipitation**: the amount of precipitation/rain in mm/h. | ||
| - **irradiance**: Sun intensity in Watt per square meter (W/m2). | ||
|
|
||
| A full configuration example: |
There was a problem hiding this comment.
Suggest rewriting this as
Full configuration example where location is manually specified.
Also this example could differ from the one above and one could only use a subset of the monitored_conditions.
| # Example configuration.yaml entry | ||
| weather: | ||
| - platform: buienradar | ||
| name: buienradar |
There was a problem hiding this comment.
Remove the name variable since it's not a required variable. It's better to limit the example configuration to only required variables since it's often copy and pasted.
| Configuration variables: | ||
| - **platform** (*Required*): buienradar | ||
| - **name** (*Optional*): A name for the weather platform. | ||
| - **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from HA configuration, but can be overridden/changed in this component to select a different location for buienradar. |
There was a problem hiding this comment.
HA should be replaced with Home Assistant
| - **platform** (*Required*): buienradar | ||
| - **name** (*Optional*): A name for the weather platform. | ||
| - **latitude** (*Optional*): latitude to use for selection of data source location. Longitude & latitude will be taken from HA configuration, but can be overridden/changed in this component to select a different location for buienradar. | ||
| - **longitude** (*Optional*): longitude to use for selection of data source location. Longitude & latitude will be taken from HA configuration, but can be overridden/changed in this component to select a different location for buienradar. |
There was a problem hiding this comment.
HA should be replaced with Home Assistant
Landrash
left a comment
Landrash
left a comment
There was a problem hiding this comment.
Looks good and can be merged when parent PR is merged.
4 participants
Description:
Added documentation for buienradar weather-component and buienradar sensor-component.
Pull request in home-assistant (if applicable): home-assistant/core/pull/7592