mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
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
Franck Nijhof
parent
f57b497757
commit
61d73b0f0f
@ -8,27 +8,29 @@ comments: false
|
||||
logo: ambient_weather.png
|
||||
ha_category: Weather
|
||||
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)
|
||||
web API to retrieve weather data from your personal weather station (PWS).
|
||||
The `Ambient Weather Station` component retrieves local weather information
|
||||
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
|
||||
under `My Account`. Requesting an application key requires emailing the ambient weather support team.
|
||||
## {% linkable_title Generating API Keys and Application Keys %}
|
||||
|
||||
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
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: ambient_station
|
||||
api_key: YOUR_API_KEY
|
||||
app_key: YOUR_APP_KEY
|
||||
monitored_conditions:
|
||||
- tempf
|
||||
- humidity
|
||||
- windspeedmph
|
||||
ambient_station:
|
||||
api_key: <YOUR API KEY>
|
||||
app_key: <YOUR APPLICATION KEY>
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -42,67 +44,67 @@ app_key:
|
||||
type: string
|
||||
monitored_conditions:
|
||||
description: Weather conditions to track.
|
||||
required: true
|
||||
required: optional
|
||||
type: list
|
||||
keys:
|
||||
winddir:
|
||||
description: Wind direction
|
||||
windspeedmph:
|
||||
description: Windspeed
|
||||
windgustmph:
|
||||
description: Wind gust
|
||||
maxdailygust:
|
||||
description: Max daily wind gust
|
||||
windgustdir:
|
||||
description: Wind gust direction
|
||||
windspdmph_avg2m:
|
||||
description: Wind speed, 2m moving average
|
||||
winddir_avg2m:
|
||||
description: Wind direction, 2m moving average
|
||||
windspdmph_avg10m:
|
||||
description: Wind speed, 10m moving average
|
||||
winddir_avg10m:
|
||||
description: Wind direction, 10m moving average
|
||||
24hourrainin:
|
||||
description: 24h rain accumulation
|
||||
baromabsin:
|
||||
description: Absolute atmospheric pressure
|
||||
baromrelin:
|
||||
description: Relative atmospheric pressure
|
||||
battout:
|
||||
description: Weather station battery health
|
||||
co2:
|
||||
description: CO2 level
|
||||
dailyrainin:
|
||||
description: Daily rain accumulation
|
||||
dewPoint:
|
||||
description: Dewpoint temperature
|
||||
eventrainin:
|
||||
description: Event Rain accumulation
|
||||
feelsLike:
|
||||
description: Feels Like temperature
|
||||
hourlyrainin:
|
||||
description: Hourly rain accumulation
|
||||
humidity:
|
||||
description: Outdoor humidity
|
||||
humidityin:
|
||||
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:
|
||||
description: Outdoor temperature
|
||||
tempinf:
|
||||
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:
|
||||
description: Lifetime rain accumulation (since last reset)
|
||||
baromrelin:
|
||||
description: Relative atmospheric pressure
|
||||
baromabsin:
|
||||
description: Absolute atmospheric pressure
|
||||
uv:
|
||||
description: UV index
|
||||
solarradiation:
|
||||
description: Solar radiation
|
||||
co2:
|
||||
description: CO2 level
|
||||
lastRain:
|
||||
description: Datetime of last rain event
|
||||
dewPoint:
|
||||
description: Dewpoint temperature
|
||||
feelsLike:
|
||||
description: Feels Like temperature
|
||||
weeklyrainin:
|
||||
description: Weekly rain accumulation
|
||||
winddir:
|
||||
description: Wind direction
|
||||
winddir_avg10m:
|
||||
description: Wind direction, 10m moving average
|
||||
winddir_avg2m:
|
||||
description: Wind direction, 2m moving average
|
||||
windgustdir:
|
||||
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 %}
|
||||
Loading…
x
Reference in New Issue
Block a user