home-assistant.io/source/_components/buienradar.markdown
Ties de Kock 9cb6f9d466 Document the buienradar camera component (#10106)
* Document the buienradar camera component

Buienradar camera had been added in 0.95 but documentation was not
added.

* ✏️ Tweak
2019-08-13 00:23:14 +02:00

4.7 KiB

title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from
title description logo ha_category ha_release ha_iot_class redirect_from
Buienradar Instructions on how to integrate buienradar.nl weather within Home Assistant. buienradar.png
Camera
Weather
0.47 Cloud Polling
/components/weather.buienradar/

The buienradar platform uses buienradar.nl as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.

The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found here.

Besides the weather platform, there is currently support for the following additional device types:

Configuration

To add the Buienradar weather to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
weather:
  - platform: buienradar

{% configuration %} name: description: "You can specify a name of the component, but do not have to. If you specify a name, the weather integration will get an entity name of weather.[name]; if no name is specified, it will try to set its name to weather.BR_[stationname]. However at the moment in time, the entity is created, no data has been retrieved yet, so the entity will get named weather.BR_unknown_station. Later the station name will be known and get updated, but the entity name remains." required: false type: string latitude: description: Latitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float longitude: description: Longitude to use for selection of data source location. Longitude and latitude will be taken from Home Assistant configuration but can be overridden/changed in this integration to select a different location for Buienradar. required: false type: float forecast: description: "true to add a temperature forecast, false to suppress it." required: false type: boolean default: true {% endconfiguration %}

Full configuration

A full configuration example:

# Example configuration.yaml entry
weather:
  - platform: buienradar
    name: 'volkel'
    # Force 'Meetstation Volkel' to be used:
    latitude: 51.65
    longitude: 5.70
    forecast: true

This platform is an alternative to the buienradar sensor. The weather platform is easier to configure but less customizable.

Camera

The buienradar camera platform uses buienradar.nl as a source for the last rain radar map. The overview image of the whole of the Netherlands is loaded and shown as a camera in Home Assistant.

Internally this component uses the radar map image as documented on buienradar.nl. The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera.

To add buienradar camera to Home Assistant, add the following section to your configuration.yaml file:

# Example configuration.yaml entry
camera:
  - platform: buienradar

{% configuration %} name: description: You can (optionally) specify the name of the camera. The name will be shown in the user interface below the radar image. required: false type: string dimension: description: Size of the image to be loaded from buienradar.nl (120 to 700 pixels) required: false default: 512 type: integer delta: description: Time interval in seconds between image updates required: false default: 600 type: integer {% endconfiguration %}

The name Variable

If you specify a name, the camera will get this name as its label. A slugified version of the name will be used as the name of the entity.

With the default of "Buienradar loop" the entity name becomes camera.buienradar_loop.

Usage statement:

Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for non-commercial purposes. Please refer to the full usage statement linked above to confirm your use or to request permission.