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!
Addon informations
Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!
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
- Create a GRDF account at https://monespace.grdf.fr/
- Configure your GRDF credentials in the config.yaml file
- Set up MQTT connection details
- 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
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
# 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.
- Add my Hass.io add-ons repository to your Hass.io instance.
- Install this add-on.
- Click the
Savebutton to store your configuration. - Start the add-on.
- Check the logs of the add-on to see if everything went well.
- Carefully configure the add-on to your preferences, see the official documentation for for that.
