Zum Hauptinhalt springen

GRDF Gazpar Smart-Home-Integration, kostenlos und Open Source

GRDF Gazpar-Integration für Gladys Assistant

Reads the daily gas consumption of your GRDF Gazpar meter from your GRDF account.

Info

Die Dokumentation dieser Integration wird von ihrem Autor geschrieben und ist bisher nur auf Englisch verfügbar.

This integration reads the gas consumption measured by your Gazpar meter and turns it into Gladys devices, so your gas shows up next to the rest of your home data: daily charts, scenes, and the energy screen.

GRDF exposes no public API for individuals. The integration therefore signs in to your customer account exactly like a browser would, on monespace.grdf.fr, and reads the same daily readings the website shows you.

What you need​

  • a GRDF customer account (the one you use on monespace.grdf.fr), with your meter already attached to it;
  • a Gazpar communicating meter — the daily readings only exist for those. With an older meter read twice a year by a technician, GRDF only publishes one lump reading per period, and that is all the integration can show;
  • an account that does not ask for an extra verification step at login (a one-time code sent by SMS or email, a captcha). The integration can only answer the password step.

Configuration​

  1. Open the Configuration tab of the integration.
  2. Enter the email and the password of your GRDF account. Once saved, the password is never sent back to your browser, and it is only ever transmitted to GRDF — see Privacy for how it is stored.
  3. Leave PCE to follow empty to follow every meter of the account. If your account holds several metering points and you only want some of them, list their 14-digit PCE numbers, separated by commas. You will find a PCE on your gas bill, and in Mon Espace GRDF.
  4. Choose the history to import: the number of past days fetched the first time the integration synchronizes. GRDF keeps about three years, so you can import several months at once if you want charts that already have a past. This only applies to the first synchronization; afterwards the integration only fetches what is new. Importing a long history takes a few minutes: Gladys accepts a limited number of measurements per minute, so the integration feeds them in gently — about one minute per two months imported.
  5. Click Test the GRDF connection: it signs in and lists the metering points it found. This is the quickest way to check your credentials.
  6. Save, then open the Discovery tab and add your meter to your home. This step is what starts the collection: until a meter is added, it is only an offer, and Gladys has nowhere to store its measurements. The history is imported the moment you add it.

The devices you get​

One device per metering point, named after the alias you gave it in Mon Espace, carrying four read-only sensors:

SensorUnitWhat it is
Consommation quotidiennekWhEnergy consumed during the gas day — the billed value
Volume quotidienm³Raw gas volume consumed during the gas day
Index compteurm³Meter index at the end of the gas day
Température extérieure moyenne°CAverage outside temperature GRDF associates to the day

Every value is recorded with the date of the day it belongs to, not the date it was downloaded: your charts stay correct even though the data arrives late.

When the data arrives​

GRDF publishes a reading one to two days late, usually during the day following the measurement. There is nothing live here: the consumption of Monday typically lands on Tuesday or Wednesday. This is a limit of the Gazpar network itself (the meter transmits once a day), not of the integration.

The integration queries GRDF on its own schedule — every six hours by default, which is far more than enough for a daily value. The Refresh the data now action forces a fetch immediately if you do not want to wait.

Troubleshooting​

"Test the GRDF connection" fails. Try signing in on monespace.grdf.fr with the same credentials in a private browser window. If GRDF asks you for a code or a captcha there, the integration cannot get through either.

The sensors exist but stay empty. Check that the meter is really added to your home, and not merely listed in the Discovery tab: Gladys only stores measurements for devices you added. Once added, the history is imported within seconds, and at worst within a minute — or use Refresh the data now. A long history takes a few minutes to appear in full: it is fed in gently (see above), oldest day first.

"No login token in the page GRDF served". GRDF answered with something other than its sign-in form. The message says what came back — a captcha, a "too many attempts" page, a maintenance notice, or an unexpected page. The first three clear up on their own after a few hours; the last one probably means GRDF changed its website and the integration needs updating. Either way, try signing in on monespace.grdf.fr from a browser first: you will see the same page the integration saw.

"GRDF served its HTML app shell" or "the session was not accepted". GRDF answered with a web page instead of data. Their site does that when it does not accept the session, and also when it is simply having a bad moment — it never says which. The integration signs in again and retries a few times on its own; if it still fails, wait a few minutes and use Refresh the data now. If it lasts, check that monespace.grdf.fr works in your browser: GRDF sometimes throttles an account that has signed in many times in a row.

No new data for several days. Check on the GRDF website that the readings are actually published for your meter: a Gazpar meter that lost its radio link stops feeding GRDF, and the integration can only show what GRDF has.

The values look wrong or duplicated. The integration remembers the last day it published for each meter, so it never re-imports the same day twice. If you delete a device and add it back, its history restarts from the import window you configured.

For the full detail of what happens, look at the integration logs from the Gladys interface (or docker logs on the host); set LOG_LEVEL=debug for the verbose version.

Privacy​

Your GRDF credentials and your consumption data stay between your Gladys server and GRDF. Nothing is sent anywhere else, and no third-party service is involved.

How your password is stored. Gladys marks it as a secret, which means it is never sent back to the browser once saved: the Configuration screen only knows that a password is set, never its value. It is, however, stored as-is in your Gladys database — Gladys stores its settings in a plain SQLite file, with no encryption at rest. Anyone with access to that server, or to a backup of it, can read it, exactly as for any other credential you enter in Gladys.

GRDF offers individuals no other way in: no API key, no token, no application-specific password. Signing in with your account password is the only option, which is why it is worth knowing where it ends up.

Konfigurationseinstellungen​

Diese Einstellungen fragt GRDF Gazpar in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
Before you startsectionNeinThis integration signs in to your GRDF customer account, the same one you use on monespace.grdf.fr, and reads the daily readings of your Gazpar meter. GRDF publishes them one to two days late: nothing shows up in real time. Your account must not require an extra verification step at login.
GRDF account emailstringJaThe email address you use to sign in on monespace.grdf.fr.
GRDF account passwordsecretJaNever sent back to your browser once saved, and only ever transmitted to GRDF. Like every Gladys setting, it is stored as-is in your server's database.
PCE to followstringNeinOptional. 14-digit metering point identifiers, separated by commas. Leave empty to follow every meter of the account.
History to import (days)numberNeinDays of past consumption imported on the first synchronization. GRDF keeps about three years.
Refresh interval (s)numberNeinHow often GRDF is queried, in seconds. A new reading appears once a day, so there is no point going below a few hours.

So installierst du GRDF Gazpar in Gladys​

  1. Öffne in Gladys Integrationen: GRDF Gazpar erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/philippema/gladys-grdf:1.1.8) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/PhilippeMA/gladys-grdf.

GRDF Gazpar benötigt Gladys >=4.86.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

GRDF Gazpar ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von PhilippeMA veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂