IMPORTANT NOTE

THIS APPLICATION IS OUT OF SERVICE SINCE THE ACTIVATION OF CAPTCHA ON GRDF WEBSITE

gazpar2mqtt

Python script to fetch GRDF's website data and publish data to a mqtt broker

Externals/Thanks

The project has been inspired by job done by empierre on project domoticz_gazpar and beufanet on project gazinflux availables on Github. I modified a bit the code to work and fit my needs. Thanks to echauvet for his big contribution on GRDF API and the calculation of new sensors.

Informations

Important : the tool is still under development, various functions may disappear or be modified.

Changelogs :

• v0.8.x :

  • Export to Influxdb v2 database
  • Grafana dashboard template
  • Cost calculation from prices file
  • Thanks to pbranly for the tests

• v0.7.x :

  • Retrieve published measures to supplier

• v0.6.x :

  • Implementation of a sqlite database
  • Addition of converter factor from Grdf
  • Calculation of aggregated consumptions for calendar periods (year, month, week and day) and rolling periods (1 year, 1 month, 1 week)
  • Retrieve of GRDF's thresold and warn when a thresold is reached
  • Exponential wait between retries when the application failed to connect to GRDF website
  • Database path editable as parameter

• v0.5.x :

  • Hard redesign of the application after new GRDF website released on 23/11/2021 . Thanks to echauvet for his contribution.
  • Published values are now PCE dependent
  • Add last index
  • Home assistant : Add entity last index which can be integrated in Hass Energy panel
  • Rework of python code
  • Add Debug mode in environment variable
  • Add connexion retries to GRDF when it failed

• v0.4.x :

  • Home assistant mqtt discovery available
  • Home assistant add-on available : https://github.com/alexbelgium/hassio-addons/tree/master/gazpar2mqtt (special thx to alexbelgium)
  • Enable Docker build for arm/v7 architecture
  • Enable MQTT SSL connexion
  • Grdf's thresholds (seuil) and previous year consumption

• v0.3.x :

  • First reliable release

Roadmap :

• Home assistant custom entity card

Requirements

Python3 and libs

python3 with its dependencies:

pip3 install -r app/requirement.txt

GRDF Gazpar API

Verify you have gazpar data available on GRDF Portal Remember, kWh provided is conversion factor dependant. Please verify it's coherent with your provider bills.

Gazpar2mqtt request the API and retrieve 4 groups of data :

Account informations

It corresponds to the customer profile, the list of PCE (Point de Comptage et d'Estimation) and its attributes (address, state, activation date)

Informative measures

GRDF provides informative measures at day level. The tool returns the last measure and several calculated indicators.

Published measures

GRDF provides published measures. It corresponds to consumptions measured by GRDF and transmitted to your gas supplier. Consequently, it should correspond to the consumption that the supplier invoices to the consumer.

Thresolds

Thresolds (Seuil) can be set on GRDF website for current and future months.

The script can retrieve those informations and publish a warn when the thresold is close to being reached.

Prices

Gazpar2mqtt can ingest your own energy prices to estimate your costs. Download and complete the sample file prices.csv using the following format :

• PCE : your PCE id
• startDate : starting date of the price
• endDate : end date of the price (put a far far end date at the last row of the file, ie : 2999-12-31)
• kwhPrice : the price per kWh (don't forget to apply the TVA to this cost, and to add the french energy tax per kwh)
• fixPrice : the fix price per day (it corresponds for example to the price of your subscription with your gas provider, don't forget to apply the TVA)

pce;startDate;endDate;kwhPrice;fixPrice
XXXX;2019-11-28;2020-12-27;0.03713;0.25
XXXX;2020-12-28;2021-01-25;0.03472;0.30
XXXX;2021-01-26;2099-12-31;0.03733;0.35

Then precise in parameters the path to the file prices.csv.

MQTT broker

A MQTT broker is required. Please check its configuration (hostname, port, remote access allowed, username & password if needed).

Parameters

Currently, parameters can be provided by command's arguments or by the OS's environment variables.

Mandatory :

Optional :

Usage

Running script

Run it manually :

python3 app/gazpar2mqtt.py

Run it manually with a selection of arguments overwritting parameters :

python3 app/gazpar2mqtt.py --grdf_username=myemail@email.com --grdf_password=mypassword --mqtt_host=myhost --mqtt_clientId=gazou --mqtt_retain=True

Schedule it manually :

python3 app/gazpar2mqtt.py --schedule 10:30

Full list of arguments :

python3 app/gazpar2mqtt.py --help

Docker

Have a look the docker repository.

Example of docker run command with some environment variables :

docker run --name app/gazpar2mqtt -e GRDF_USERNAME=gazou@email.com -e GRDF_PASSWORD=password -e MQTT_HOST=192.168.1.99 -e MQTT_PORT=1883 -e MQTT_CLIENTID=gazou -e MQTT_QOS=1 -e MQTT_TOPIC=gazpar -e MQTT_RETAIN=False --tty yukulehe/gazpar2mqtt:latest

Standalone mode

Default mode, gazpar2mqtt is autonomous and is not dependent of any third-party tool. You can replace the default topic prefix gazpar (see mqtt broker requirements chapter)

Measures :

Last measures :

Published measures :

Calculated calendar measures :

Calculated rolling measures :

Calculated thresold measures :

Note : thresold percentage can be editable in environment variable

Status :

Home Assistant discovery mode

Gazpar2mqtt provides Home Assistant compatible Mqtt devices. The discovery function enable to use MQTT devices with a minimal configuration effort. Have a look to Home Assistant Mqtt discovery documentation.

Device :

Note : you can replace the default device name gazpar by editing the related parameter.

List of entities :

Last informative measure entities :

Last published measure entities :

Calendar measure entities :

Rolling measure entities :

Calculated thresold measures :

Note : thresold percentage can be editable in environment variable.

Add-on

For Hass.io users, gazpar2mqtt is also available as an add-on provided by alexbelgium (thanks you to him). Please visit the dedicated repository.

InfluxDb & Grafana

You can activate export of data to your InfluxDb v2 database. InfluxDb v1 is currently not supported.

Example of a Grafana dashboard using InfluxDb v2 and gazpar2mqtt measures :

To integrate this dashboard into Grafana, copy/paste content of file grafana_sample.json.