Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felddy/weewx-home-assistant
Publishes WeeWX weather stations as devices in Home Assistant
https://github.com/felddy/weewx-home-assistant
home-assistant mqtt weewx
Last synced: 1 day ago
JSON representation
Publishes WeeWX weather stations as devices in Home Assistant
- Host: GitHub
- URL: https://github.com/felddy/weewx-home-assistant
- Owner: felddy
- License: mit
- Created: 2024-11-27T16:12:02.000Z (2 months ago)
- Default Branch: develop
- Last Pushed: 2024-12-28T23:11:39.000Z (about 1 month ago)
- Last Synced: 2025-02-04T18:46:14.258Z (2 days ago)
- Topics: home-assistant, mqtt, weewx
- Language: Python
- Homepage:
- Size: 769 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# weewx-home-assistant 🌦️➡️🏠 #
[](https://github.com/felddy/weewx-home-assistant/actions)
[](https://github.com/felddy/weewx-home-assistant/actions/workflows/codeql-analysis.yml)
[](https://coveralls.io/github/felddy/weewx-home-assistant?branch=develop)
[](https://snyk.io/test/github/felddy/weewx-home-assistant)
This [WeeWX](http://www.weewx.com/) extension simplifies the integration of a
weather station with [Home Assistant](https://www.home-assistant.io/). By
leveraging Home Assistant's [MQTT](https://mqtt.org/) discovery protocol, it
automatically creates entities for weather data, significantly reducing manual
configuration. Additionally, it ensures that all weather data is securely
transmitted and devices are always accurately represented, thanks to its support
for availability messages.
Key Features:
- **Simplified Setup**: Implements Home Assistant's MQTT discovery, allowing
easy and automatic integration of weather station measurements.
- **Secure by Default**: Encryption is enabled, and anonymous connections are
not supported, ensuring your data remains protected.
- **Robust Availability**: Supports MQTT Last Will and Testament (LWT) to
accurately report device availability in Home Assistant.
- **Flexible Integration**: Supports multiple sensors and measurements with
dynamic configuration, adapting easily to different weather station models and
measurement units.
## Prerequisites ##
- A functioning installation of [WeeWX](http://www.weewx.com/) version `5.1` or
later using [Python](https://www.python.org/) version `3.10` or later.
- A functioning MQTT broker.
> [!TIP]
> We recommend using our [WeeWX Docker
> image](https://github.com/felddy/weewx-docker) to simplify the installation
> and configuration of WeeWX in conjunction with the
> [Mosquitto](https://mosquitto.org/) broker which can be installed as a [Home
> Assistant
> add-on](https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md).
## Installation ##
```shell
pip install git+https://github.com/felddy/[email protected]
```
## Configuration ##
Add the extension controller to `report_services` in the `weewx.conf` file:
```ini
[Engine]
[[Services]]
report_services = weewx_ha.Controller
```
Add a configuration section to the root of the `weewx.conf` file:
```ini
[HomeAssistant]
node_id = weewx
[[mqtt]]
hostname = mqtt.example.com
password = mqttPassword
username = mqttUser
[[station]]
name = Weather Station
model = Vantage Vue
manufacturer = Davis
```
> [!IMPORTANT]
>
> - The `node_id` is used to group the weather station entities in the [MQTT
> discovery
> topic](https://www.home-assistant.io/integrations/mqtt/#discovery-messages).
> - The `station.name` is used by Home Assistant as the device name and the
> prefix to all entities.
## Advanced Configuration ##
```ini
[HomeAssistant]
discovery_topic_prefix =
node_id =
state_topic_prefix =
unit_system =
[[mqtt]]
client_id =
hostname =
keep_alive =
password =
port =
username =
use_tls =
[[[tls]]]
cadata =
cafile =
capath =
certfile =
keyfile =
password =
[[station]]
manufacturer =
model =
name =
timezone =
```
> [!NOTE]
> Information about `TLS` options can be found in the Python documentation:
>
> - `cadata`, `cafile`, `capath`:
> [ssl.create_default_context](https://docs.python.org/3/library/ssl.html#ssl.create_default_context)
> - `certfile`, `keyfile`, `password`:
> [ssl.SSLContext.load_cert_chain](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain)
## Contributing ##
We welcome contributions! Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for
details.
## License ##
This project is released as open source under the [MIT license](LICENSE).
All contributions to this project will be released under the same MIT license.
By submitting a pull request, you are agreeing to comply with this waiver of
copyright interest.