Skip to content

Latest commit

 

History

History
89 lines (45 loc) · 4.14 KB

DOCS.md

File metadata and controls

89 lines (45 loc) · 4.14 KB
Raw

Home Assistant Community Add-on: WeatherFlow2MQTT

This add-on allows you to get data from a WeatherFlow weather station using UDP. There is support for both the new Tempest station and the older AIR & SKY station.

Important: this add-on uses the same timezone and unit system as your Home Assistant instance, so make sure it has been properly set.

Installation

To install the add-on, first follow the installation steps from the README on GitHub.

Configuration

Option: ELEVATION: (default: Home Assistant Elevation)

Set the height above sea level for where the station is placed. This is used when calculating some of the sensor values. Station elevation plus Device height above ground. The value has to be in meters (meters = feet * 0.3048). Default is Home Assistant Elevation

Option: LATITUDE: (default: Home Assistant Latitude)

Set the latitude for where the station is placed. This is used when calculating some of the sensor values. Default is Home Assistant Latitude

Option: LONGITUDE: (default: Home Assistant Longitude)

Set the longitude for where the station is placed. This is used when calculating some of the sensor values. Default is Home Assistant Longitude

Option: RAPID_WIND_INTERVAL: (default: 0)

The weather stations delivers wind speed and bearing every 2 seconds. If you don't want to update the HA sensors so often, you can set a number here (in seconds), for how often they are updated. Default is 0, which means data are updated when received from the station.

Option: STATION_ID: (default: None)

Enter your Station ID for your WeatherFlow Station.

Option: STATION_TOKEN: (default: None)

Enter your personal access Token to allow retrieval of data. If you don't have the token login with your account and create the token. NOTE You must own a WeatherFlow station to get this token.

Option: FORECAST_INTERVAL: (default: 30)

The interval in minutes, between updates of the Forecast data.

Option: LANGUAGE: (default: en)

Use this to set the language for Wind Direction cardinals and other sensors with text strings as state value. These strings will then be displayed in HA in the selected language.

Option: FILTER_SENSORS: (default: None)

A comma-separated list of sensors to include instead of loading all sensors. Default is None, which disables filtering such that all sensors are loaded.

Option: INVERT_FILTER: (default: False)

If set to True, FILTER_SENSORS will be treated as an exclusion list such that the specified sensors are ignored. Default is False.

Option: MQTT_HOST: (default: Installed MQTT Add-On IP)

The IP address of your mqtt server. Even though you have the MQTT Server on the same machine as this Container, don't use 127.0.0.1 as this will resolve to an IP Address inside your container. Use the external IP Address.

Option: MQTT_PORT: (default: 1883)

The Port for your mqtt server. Default value is 1883

Option: MQTT_USERNAME: (default: Installed MQTT Add-On username)

The username used to connect to the mqtt server. Leave blank to use Anonymous connection.

Option: MQTT_PASSWORD: (default: Installed MQTT Add-On password)

The password used to connect to the mqtt server. Leave blank to use Anonymous connection.

Option: MQTT_DEBUG: (default: False)

Set this to True, to get some more mqtt debugging messages in the Container log file.

Option: WF_HOST: (default: 0.0.0.0)

Unless you have a very special IP setup or the Weatherflow hub is on a different network, you should not change this. Default is 0.0.0.0

Option: WF_PORT: (default: 50222)

Weatherflow always broadcasts on port 50222/udp, so don't change this. Default is 50222

Option: DEBUG: (default: False)

Set this to True to enable more debug data in the Container Log.

Authors & contributors

The original setup of this repository is by Bjarne Riis.

For a full list of all authors and contributors, check the contributor's page.