weatherflow2mqtt

weatherflow2mqtt

Docker app from ssickle's Repository

Overview

This project monitors the UDP socket (50222) from a WeatherFlow Hub, and publishes the data to a MQTT Server. Data is formatted in a way that, it supports the MQTT Discovery format for Home Assistant, so a sensor will created for each entity that WeatherFlow sends out, if you have MQTT Discovery enabled. Everything runs in a pre-built Docker Container, so installation is very simple. You only need Docker installed on a computer and a MQTT Server setup somewhere in your network. If you run either the Operating System or Supervised installation of Home Assistant, you will have easy access to both. There is support for both the AIR & SKY devices and the TEMPEST device. Please review Breaking Changes prior to updating your instance. Breaking changes will be listed in https://github.com/briis/hass-weatherflow2mqtt/blob/main/CHANGELOG.md See Breaking Changes section under 2021-12-10 for steps to updating naming conventions.

Requirements

//mosquitto\\

Runtime arguments

Network
host
Shell
sh
Privileged
false
Extra Params
--restart unless-stopped

Template configuration

Is TempestVariable
Target
TEMPEST_DEVICE
Default
True
Station IDVariable

Enter your Station ID for your WeatherFlow Station. Default value is blank.

Target
STATION_ID
Station TokenVariable

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. Default value is blank

Target
STATION_TOKEN
MQTT HostVariable

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. Default value is 127.0.0.1 (Required)

Target
MQTT_HOST
Default
[IP]
MQTT PortVariable

The Port for your mqtt server. Default value is 1883

Target
MQTT_PORT
Default
1883
MQTT UserVariable

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

Target
MQTT_USERNAME
MQTT PasswordVariable

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

Target
MQTT_PASSWORD
Retreive ForcastVariable

Set this to True if you want to retrieve Forecast Data from WeatherFlow. If set to True, STATION_ID and STATION_TOKEN must be filled also. NOTE If this is enabled the component will access the Internet to get the Forecast data. Default value is False

Target
ADD_FORECAST
Default
False
Forcast Fetch IntervalVariable

The interval in minutes, between updates of the Forecast data. Default value is 30 minutes.

Target
FORECAST_INTERVAL
Default
30
Unit SystemVariable

Enter imperial or metric. This will determine the unit system used when displaying the values. Default is metric

Target
UNIT_SYSTEM
Default
metric
ElevationVariable

Set the hight 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 0

Target
ELEVATION
Default
0
LanguageVariable

Currently these languages are supported for Wind Cardinals and other Text state strings: en: English da: Danish If you would like to assist in translating to a new language, do the following: From the translations directory on this Github Project, download the file en.json Rename the file to YourLanguageCode.json - example for Spanish rename it to es.json Edit the file and translate the strings Make a pull request in Github and attach the file.

Target
LANGUAGE
Default
en
Config DirectoryPathrw
Target
/usr/local/config
Default
/mnt/user/appdata/weatherflow2mqtt
Value
/mnt/user/appdata/weatherflow2mqtt
RAPID_WIND_INTERVALVariable

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.

Default
0
Value
0
WF_HOSTVariable

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

Default
0.0.0.0
Value
0.0.0.0
WF_PORTVariable

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

Default
50222
Value
50222
MQTT_DEBUGVariable

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

Default
False
Value
False
DEBUGVariable

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

Default
False
Value
False

Categories

Download Statistics

380,357
Total Downloads
2,045
This Month
1,638
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
briis/weatherflow2mqtt
Last Updated2023-10-08
First Seen2022-07-24

Run Weatherflow2mqtt on Unraid.

Weatherflow2mqtt is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.