Home-Assistant-Wundergroundpws Overview
The Home-Assistant-Wundergroundpws project offers a custom integration for Home Assistant users who have personal weather stations registered with Weather Underground. This integration harnesses real-time data from personal weather stations to present current weather conditions and forecasts within Home Assistant's interface.
Features of the Integration
-
Weather Entity: It includes a native Home Assistant weather entity that displays comprehensive weather details.
-
Weather Sensors: A variety of weather sensors are incorporated, providing detailed weather metrics from personal weather stations.
-
Current Conditions: These are based on data from the specific station ID configured in the Weather Underground account.
-
Forecast: Weather forecasts are generated using the geographical coordinates of the personal weather station.
Prerequisites for Installation
To ensure a smooth setup, users must meet certain prerequisites:
- The integration is designed for the Home Assistant version 2023.1 or greater.
- Users must possess a registered and active Weather Underground personal weather station API key.
Acquiring a Weather Underground API Key
An essential step for using the wundergroundpws integration is obtaining a Weather Underground API key:
- Register and upload your personal weather station data to Weather Underground.
- Access the API key through the Weather Underground member portal.
Installation Steps
To install the wundergroundpws integration:
- Download the latest version from the project's repository.
- Extract the download and copy the custom components to your Home Assistant directory.
- Integrate it into Home Assistant by navigating to DEVICES & SERVICES, then ADD INTEGRATION.
- Provide your API key and Station ID during the integration setup process.
After installation, configure specific settings like creating forecast sensors, precision levels, language preference, and more. Multiple instances can be created by using different Station IDs or API Keys.
Upgrading to v2.x.x
If upgrading from earlier versions, note that this isn't a direct upgrade. Prior versions must be removed completely, and reinstallation of v2.x.x is necessary.
Configuration Options
Users can customize their integration setup with various configuration options, including:
- Forecast Sensors: Toggle the creation and enablement of forecast sensors.
- Numeric Precision: Choose between displaying data in integer or decimal format.
- Language: Specify the API return language, default being English.
- Temperature by Calendar Day: Opt to retrieve forecast temperatures by calendar day.
Description of Terms and Variables
Important elements for configuration include:
api_key
: Essential for accessing Weather Underground services.pws_id
: The unique station ID for your personal weather station.numeric_precision
: Controls how current sensor values are presented.lang
: Determines the language used for API responses and sensor names.
Available Sensors
The integration provides a comprehensive set of sensors that include readings for humidity, solar radiation, wind parameters, temperature, and precipitation, among others. These sensors update every five minutes to ensure real-time accuracy.
Weather Entity
The weather entity collates data into a simplified format displayed in the Home Assistant weather card, showing current and forecasted weather information like temperature, humidity, wind speed, and precipitation.
Sensors for Statistics
The wundergroundpws sensors can be displayed in statistics cards, useful for tracking various weather metrics over time.
Localization
Localization is facilitated through translation files included in the integration, allowing users to see sensor names in their preferred language. However, the primary language of interaction with Weather Underground remains English unless otherwise configured.
The Home-Assistant-Wundergroundpws project stands as a valuable tool for weather enthusiasts, offering granular weather insights through a seamless Home Assistant integration.