Add doc updates for upcoming Ambient PWS changes (#8244)

* Add doc updates for upcoming Ambient PWS changes

* Updated method to Cloud Push
This commit is contained in:
Aaron Bach 2019-01-29 05:12:02 -07:00 committed by Franck Nijhof
parent f57b497757
commit 61d73b0f0f

View File

@ -8,27 +8,29 @@ comments: false
logo: ambient_weather.png logo: ambient_weather.png
ha_category: Weather ha_category: Weather
ha_release: "0.85" ha_release: "0.85"
ha_iot_class: "Cloud Polling" ha_iot_class: "Cloud Push"
--- ---
The `Ambient Weather Station` platform uses the [Ambient Weather](https://ambientweather.net) The `Ambient Weather Station` component retrieves local weather information
web API to retrieve weather data from your personal weather station (PWS). via personal weather stations from
[Ambient Weather](https://ambientweather.net).
You need to register your compatible PWS using its MAC address and then request both an API key and an Application key. The key requests can be found ## {% linkable_title Generating API Keys and Application Keys %}
under `My Account`. Requesting an application key requires emailing the ambient weather support team.
To add your Ambient Weather PWS to your Home Assistant installation, add the following to your `configuration.yaml` file: Using this component requires both an Application Key and an API Key. To
generate both, simply utilize the profile section of
[your Ambient Weather dashboard](https:/dashboard.ambientweather.net).
## {% linkable_title Configuration %}
To add your Ambient Weather PWS to your Home Assistant installation, add the
following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: ambient_station:
- platform: ambient_station api_key: <YOUR API KEY>
api_key: YOUR_API_KEY app_key: <YOUR APPLICATION KEY>
app_key: YOUR_APP_KEY
monitored_conditions:
- tempf
- humidity
- windspeedmph
``` ```
{% configuration %} {% configuration %}
@ -42,67 +44,67 @@ app_key:
type: string type: string
monitored_conditions: monitored_conditions:
description: Weather conditions to track. description: Weather conditions to track.
required: true required: optional
type: list type: list
keys: keys:
winddir: 24hourrainin:
description: Wind direction description: 24h rain accumulation
windspeedmph: baromabsin:
description: Windspeed description: Absolute atmospheric pressure
windgustmph: baromrelin:
description: Wind gust description: Relative atmospheric pressure
maxdailygust: battout:
description: Max daily wind gust description: Weather station battery health
windgustdir: co2:
description: Wind gust direction description: CO2 level
windspdmph_avg2m: dailyrainin:
description: Wind speed, 2m moving average description: Daily rain accumulation
winddir_avg2m: dewPoint:
description: Wind direction, 2m moving average description: Dewpoint temperature
windspdmph_avg10m: eventrainin:
description: Wind speed, 10m moving average description: Event Rain accumulation
winddir_avg10m: feelsLike:
description: Wind direction, 10m moving average description: Feels Like temperature
hourlyrainin:
description: Hourly rain accumulation
humidity: humidity:
description: Outdoor humidity description: Outdoor humidity
humidityin: humidityin:
description: Indoor humidity description: Indoor humidity
lastRain:
description: Datetime of last rain event
maxdailygust:
description: Max daily wind gust
monthlyrainin:
description: Monthly rain accumulation
solarradiation:
description: Solar radiation
tempf: tempf:
description: Outdoor temperature description: Outdoor temperature
tempinf: tempinf:
description: Indoor temperature description: Indoor temperature
battout:
description: Weather station battery health
hourlyrainin:
description: Hourly rain accumulation
dailyrainin:
description: Daily rain accumulation
24hourrainin:
description: 24h rain accumulation
weeklyrainin:
description: Weekly rain accumulation
monthlyrainin:
description: Monthly rain accumulation
yearlyrainin:
description: Yearly rain accumulation
eventrainin:
description: Event Rain accumulation
totalrainin: totalrainin:
description: Lifetime rain accumulation (since last reset) description: Lifetime rain accumulation (since last reset)
baromrelin:
description: Relative atmospheric pressure
baromabsin:
description: Absolute atmospheric pressure
uv: uv:
description: UV index description: UV index
solarradiation: weeklyrainin:
description: Solar radiation description: Weekly rain accumulation
co2: winddir:
description: CO2 level description: Wind direction
lastRain: winddir_avg10m:
description: Datetime of last rain event description: Wind direction, 10m moving average
dewPoint: winddir_avg2m:
description: Dewpoint temperature description: Wind direction, 2m moving average
feelsLike: windgustdir:
description: Feels Like temperature description: Wind gust direction
windgustmph:
description: Wind gust
windspdmph_avg10m:
description: Wind speed, 10m moving average
windspdmph_avg2m:
description: Wind speed, 2m moving average
windspeedmph:
description: Windspeed
yearlyrainin:
description: Yearly rain accumulation
{% endconfiguration %} {% endconfiguration %}