WeatherFlow Forecast and Sensor integration for Home Assistant

Home Assistant integration for WeatherFlow Cloud Based Data using the REST API

This integration adds support for retrieving the Forecast, Current condition and optionally realtime data from WeatherFlow. It replaces WeatherFlow Weather for Home Assistant that will soon be deprecated.

For this integration you must own a WeatherFlow weather station and you must create a personal API Token that work with your weather station. See this link for a description on how to retrieve the API Token. Note: There are two types of authorization oAuth and Personal API Token. Make sure you use the later.

Note: All development is done using a TEMPEST device, so no testing of the code is done using the old AIR and SKY devices. It does not mean that it will not work with that setup, but some sensors will not be available and no testing is done. Please do not add ask me to implement special features for these device, as it will not happen. This is open source, so you are welcome to create your own fork and implement as desired.

This integration will set up the following platforms.

Minimum required version of Home Assistant is 2023.9.0 as this integration uses the new Weather entity forecast types and it does not create Forecast Attributes.

Installation through HACS (Recommended Method)

This Integration is part of the default HACS store. Search for WeatherFlow Forecast under Integrations and install from there. After the installation of the files, you must restart Home Assistant, or else you will not be able to add WeatherFlow Forecast from the Integration Page.

If you are not familiar with HACS, or haven't installed it, I would recommend to look through the HACS documentation, before continuing. Even though you can install the Integration manually, I would recommend using HACS, as you would always be reminded when a new release is published.

Manual Installation

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
2. If you do not have a custom_components directory (folder) there, you need to create it.
3. In the custom_components directory (folder) create a new folder called weatherflow_forecast.
4. Download all the files from the custom_components/weatherflow_forecast/ directory (folder) in this repository.
5. Place the files you downloaded in the new directory (folder) you created.
6. Restart Home Assistant
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "WeatherFlow Forecast"

Configuration

To add WeatherFlow Forecast to your installation, do the following:

• Go to Configuration and Integrations

• Click the + ADD INTEGRATION button in the lower right corner.

• Search for WeatherFlow Forecast* and click the integration.

• When loaded, there will be a configuration box, where you must enter:

  Parameter	Required	Default Value	Description
  Station ID	Yes	None	Each WeatherFlow Station you setup, will get a unique Station ID, this id is needed during configuration. To get your Station ID, login with your account, select the station on the list, and then click Status. Here you will find your Station ID.
  API Token	Yes	None	The WeatherFlow REST API requires a Token. Please login with your account and create the token. Go to Settings and choose Data Authorizations (almost at the bottom). Create a personal access token and use that as Token (API key).
  Forecast Hours	No	48	Adjust the number of hours you want returned for the hourly forecast. Min is 12, max is 96 hours.
  Add Sensors	No	False	Mark the box if you want to have all the available sensors from the Rest API add to Home Assistant

• Click on SUBMIT to save your data. If all goes well you should now have a new Weather entity with data from WeatherFlow Forecast

• Please Note: The Token you create here will ONLY work with Stations that are registered under the same Login.

You can configure more than 1 instance of the Integration by using a different Station ID.

Available Sensors

Here is the list of sensors that the program generates. Calculated means, if No, then data comes directly from the Weather Station, if yes, it is a sensor that is derived from some of the other sensors. Not all sensors show up on all installations. It depends on where in the world your station is located.

Binary Sensors

All entities are prefixed with [STATION NAME]_binary_sensors_

Sensors

All entities are prefixed with [STATION NAME]_sensors_

Enable Debug Logging

If logs are needed for debugging or reporting an issue, use the following configuration.yaml:

logger:
  default: error
  logs:
    pyweatherflow-forecast: debug
    custom_components.weatherflow_forecast: debug