Xweatherly is a custom integration for Home Assistant that provides detailed weather, forecast, and air quality data from Xweather.com. The service is highly regarded for its accuracy, consistently receiving high rankings from Forecast Advisor.
This integration provides a comprehensive set of entities for your smart home:
- Weather Entity: A single
weather.xweatherlyentity that:- Shows current conditions including temperature, humidity, pressure, wind speed, and visibility
- Shows a daily and hourly forecasts with configurable time horizons (default is 24 hours, and 7 days)
- Is suitable for use on dashboards
- Individual Sensors: Separate sensors are created for key data points, including:
- Temperature, humidity, wind speed, and "feels-like" temperature
- Cloud coverage, UV index, visibility, and precipitation
- Specific daily forecast data for today and tomorrow
- Air Quality:
- A primary
air_qualityentity showing the Air Quality Index (AQI) - Separate pollutant sensors for PM2.5, PM10, O3, CO, NO2, and SO2
- A primary
- Additional Functionality:
- A Refresh button on the device page for immediate data updates.
- Full support for Home Assistant's unit system (metric or imperial).
- All sensors, including condition, forecast, and AQI, update with each update interval.
- All entities are grouped under a single xweatherly device, making them easy to find.
To use this integration, you'll need an API key and secret from xweather.com.
- Free Access: You may be eligible for a free API key if you own a personal weather station (PWS) and sign up for the Contributor Plan.
- PWS Upload: If your personal weather station doesn't automatically upload data to PWSWeather, you can use the PWS Weather Station Upload Home Assistant Blueprint to send your sensor data to the service.
- Go to HACS, search for Xweatherly, and select DOWNLOAD.
- Restart Home Assistant when prompted.
- Copy the
custom_components/xweatherlyfolder into your Home Assistant'scustom_componentsdirectory. - Restart Home Assistant.
Once the integration is installed, follow these steps:
- Navigate to Settings > Devices & Services > Add Integration.
- Search for and select Xweatherly.
- A configuration form will appear where you'll need to enter the following details:
- Client ID (your Xweather API client ID)
- Client Secret (your Xweather API client secret)
- Latitude / Longitude (defaults to your Home Assistant location)
- Name: The base name for your weather and sensor entities (default is
Xweatherly) - Update interval: How often the integration will poll the API in minutes (default is 60). Each update makes four API calls (conditions, air quality, hourly, and daily forecast). That does not necessarily translate into the number of API calls registered by Xweather because they apply multipliers based on several factors. As configured by default, this integration makes 4 API calls per hour, but, because of multipliers, that is billed as 12 API calls by Xweather.
After configuration, you will find:
- A Weather entity:
weather.xweatherly - An Air Quality entity:
air_quality.xweatherly_air_quality - Individual sensors: e.g.,
sensor.xweatherly_temperature,sensor.xweatherly_humidity - A device page that groups all these entities and includes a Refresh button for manual updates.
All standard Home Assistant condition data are available as attributes on the main weather entity. The weather.get_forecasts action can be used to access additional elements from the hourly and daily forecasts.
Community involvement is welcome.
- If you've found a bug, please open an issue describing the problem and the steps to reproduce it.
- For new feature ideas, please open an issue to discuss it before you submit a pull request.