Improved and new docs for BOM weather (#1703)

This commit is contained in:
Zac Hatfield Dodds 2017-01-15 22:13:48 +11:00 committed by Fabian Affolter
parent f72a7838e7
commit 3696c004dc
2 changed files with 48 additions and 28 deletions

View File

@ -12,25 +12,11 @@ ha_category: Weather
ha_release: 0.29
---
The `bom` platform allows you to get the current weather conditions from the [Bureau of Meteorology (BOM)](http://www.bom.gov.au/) Australia.
The `bom` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data.
- Each sensor will be given the `device_id` of "bom [optionalname] friendlyname units"
- A name is optional but if multiple BOM weather stations are used a name will be required.
- The sensor will update every minute 35 minutes after last data timestamp. This allows for the 30 minute observation cycle and the approximate 5 minute update delay in publishing the data.
To get the station ID `[zone_id]` and `[wmo_id]` for your local BOM station:
- Find your station on these maps:
- NSW: http://www.bom.gov.au/nsw/observations/map.shtml
- QLD: http://www.bom.gov.au/qld/observations/map.shtml
- VIC: http://www.bom.gov.au/vic/observations/map.shtml
- WA: http://www.bom.gov.au/wa/observations/map.shtml
- SA: http://www.bom.gov.au/sa/observations/map.shtml
- TAS: http://www.bom.gov.au/tas/observations/map.shtml
- ACT: http://www.bom.gov.au/act/observations/canberramap.shtml
- NT: http://www.bom.gov.au/nt/observations/map.shtml
- alternatively, from the [BOM website](http://www.bom.gov.au/), navigate to State -> Observations -> Latest Observations -> Choose the station.
- The URL will look like: http://www.bom.gov.au/products/[zone_id]/[zone_id].[wmo_id].shtml
- For Adelaide, the URL will look like http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml.
- The sensor checks for new data every minute, starting 30 minutes after the timestamp of the most recent data as the data is updated every half-hour.
To add the BOM weather observation to your installation, add the following to your `configuration.yaml` file:
@ -38,17 +24,9 @@ To add the BOM weather observation to your installation, add the following to yo
# Example configuration.yaml entry
sensor:
- platform: bom
zone_id: IDS60801
wmo_id: 94675
station: IDS60801.94675
name: Adelaide
monitored_conditions:
- wmo
- name
- history_product
- local_date_time
- local_date_time_full
- aifstime_utc
- lat
- lon
- apparent_t
- cloud
- cloud_base_m
@ -77,9 +55,19 @@ sensor:
- wind_spd_kt
```
To get the station ID for any BOM station:
- Find your station on these maps: [NSW](http://www.bom.gov.au/nsw/observations/map.shtml), [QLD](http://www.bom.gov.au/qld/observations/map.shtml), [VIC](http://www.bom.gov.au/vic/observations/map.shtml), [WA](http://www.bom.gov.au/wa/observations/map.shtml), [SA](http://www.bom.gov.au/sa/observations/map.shtml), [TAS](http://www.bom.gov.au/tas/observations/map.shtml), [ACT](http://www.bom.gov.au/act/observations/canberramap.shtml), [NT](http://www.bom.gov.au/nt/observations/map.shtml).
- alternatively, from the [BOM website](http://www.bom.gov.au/), navigate to State -> Observations -> Latest Observations -> Choose the station.
- The URL will look like: http://www.bom.gov.au/products/IDx60801/[station].shtml
- For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`.
Configuration variables:
- **zone_id** (*Required*): The zone_id as identified from the BOM website.
- **wmo_id** (*Required*): The wmo as identified from the BOM website.
- **station** (*Optional*): The station ID string as identified from the BOM website. If not given, defaults to the closest station.
- **name** (*Optional*): The name you would like to give to the weather station.
- **monitored_conditions** (*Required*): A list of the conditions to monitor.
<p class='note'>
This sensor is an alternative to the [`bom`](/components/weather.bom/) weather platform.
The weather platform is easier to configure but less customisable.
</p>

View File

@ -0,0 +1,32 @@
---
layout: page
title: "Bureau of Meteorology (BOM) Australia"
description: "Instructions on how to integrate Bureau of Meteorology Australia weather conditions into Home Assistant."
date: 2016-09-29 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bom.png
ha_category: Weather
ha_release: 0.36
---
The `bom` weather platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data.
To add the BOM weather platform to your installation, add the following to your `configuration.yaml` file:
```yaml
weather:
- platform: bom
```
Configuration variables:
- **name** (*Optional*): The name you would like to give to the weather station.
- **station** (*Optional*): The station ID string; defaults to the closest station. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station.
<p class='note'>
This platform is an alternative to the [`bom`](/components/sensor.bom/) sensor.
The weather platform is easier to configure but less customisable.
</p>