mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-03-14 00:44:18 +01:00
8a0f15413c
Add the "Add repository to my Home Assistant" blue button to all addon README files that were missing it. This makes it easier for new HA users to add the repository with a single click. Updated 59 addon READMEs: - 51 with standard Installation section format - 8 with non-standard or missing Installation sections Co-authored-by: alexbelgium <44178713+alexbelgium@users.noreply.github.com>
111 lines
5.4 KiB
Markdown
111 lines
5.4 KiB
Markdown
# Home assistant add-on: gazpar2mqtt
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
Python script to fetch GRDF data and publish data to a mqtt broker.
|
|
See its github for all informations : https://github.com/ssenart/gazpar2mqtt
|
|
|
|
## Configuration
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
This addon fetches gas consumption data from GRDF (French gas utility) and publishes it to MQTT for Home Assistant integration.
|
|
|
|
### Setup Steps
|
|
|
|
1. Create a GRDF account at https://monespace.grdf.fr/
|
|
2. Configure your GRDF credentials in the config.yaml file
|
|
3. Set up MQTT connection details
|
|
4. Monitor data retrieval in the addon logs
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `CONFIG_LOCATION` | str | `/config/gazpar2mqtt/config.yaml` | Path to configuration file |
|
|
| `TZ` | str | `Europe/Paris` | Timezone (e.g., `Europe/London`) |
|
|
| `mqtt_autodiscover` | bool | `true` | Enable MQTT autodiscovery |
|
|
| `verbose` | bool | `true` | Enable verbose logging |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
CONFIG_LOCATION: "/config/gazpar2mqtt/config.yaml"
|
|
TZ: "Europe/Paris"
|
|
mqtt_autodiscover: true
|
|
verbose: false
|
|
```
|
|
|
|
### Configuration File
|
|
|
|
The main configuration is done via `/config/gazpar2mqtt/config.yaml`. This file contains:
|
|
- GRDF account credentials
|
|
- MQTT broker settings
|
|
- Data retrieval intervals
|
|
- Device configurations
|
|
|
|
### Required Configuration in config.yaml
|
|
|
|
```yaml
|
|
# GRDF Credentials
|
|
grdf:
|
|
username: "your-grdf-username"
|
|
password: "your-grdf-password"
|
|
|
|
# MQTT Settings
|
|
mqtt:
|
|
host: "homeassistant.local"
|
|
port: 1883
|
|
username: "mqtt-user"
|
|
password: "mqtt-password"
|
|
topic_prefix: "gazpar"
|
|
|
|
# Optional: Update frequency
|
|
update_frequency: 3600 # seconds
|
|
```
|
|
|
|
For complete configuration options, see: https://github.com/ssenart/gazpar2mqtt
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|