From 61d73b0f0fc8fd6515c14167f2430c9fa472e0b8 Mon Sep 17 00:00:00 2001 From: Aaron Bach Date: Tue, 29 Jan 2019 05:12:02 -0700 Subject: [PATCH] Add doc updates for upcoming Ambient PWS changes (#8244) * Add doc updates for upcoming Ambient PWS changes * Updated method to Cloud Push --- ...tion.markdown => ambient_station.markdown} | 130 +++++++++--------- 1 file changed, 66 insertions(+), 64 deletions(-) rename source/_components/{sensor.ambient_station.markdown => ambient_station.markdown} (76%) diff --git a/source/_components/sensor.ambient_station.markdown b/source/_components/ambient_station.markdown similarity index 76% rename from source/_components/sensor.ambient_station.markdown rename to source/_components/ambient_station.markdown index b7042957996..0c1568f76fb 100644 --- a/source/_components/sensor.ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -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: + app_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 + 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 %}