A Home Assistant add-on to sync Energy dashboards with your Linky smart meter

N.B: Because this tool is targeted for French users, the documentation is...in French!

HA Linky est un add-on pour Home Assistant permettant de synchroniser les données votre compteur Linky avec les tableaux de bord d'énergie de Home Assistant.

Il utilise le module @bokub/linky et le service Conso API pour communiquer avec Enedis et récupérer votre consommation.

Pour utiliser cet add-on, il vous faut :

• Un compteur Linky
• Un espace client Enedis
• Un token d'accès, à générer sur Conso API

• Cliquez ici pour ajouter le repository à Home Assistant. Si le lien ne fonctionne pas :
  • Depuis Home Assistant, ouvrez le menu Paramètres / Settings, puis Modules complémentaires / Add-ons
  • Cliquez sur le bouton Boutique / Store en bas à droite
  • Cliquer sur les trois points en haut à droite, puis Dépôts / Repositories
  • Ajoutez https://github.com/bokub/ha-linky
• Cliquez sur Ajouter / Add puis fermez la boite de dialogue
• Cherchez Linky dans la liste des add-ons et cliquez dessus (vous pouvez utiliser la barre de recherche)
• Installez l'add-on en cliquant sur le bouton dédié

Une fois l'add-on installé, rendez-vous dans l'onglet Configuration et remplissez les champs vides

• consumption PRM : Votre numéro de PRM (14 chiffres) pour la consommation.
  • Si vous ne le connaissez pas, entrez votre token sur la page exemples de Conso API et le PRM s'affichera dans le champ PRM
  • Vous pouvez également le trouver sur votre compteur en appuyant sur la touche + jusqu’à lire la valeur du numéro de PRM.
• consumption token : Votre token Conso API
• consumption name : Choisissez le nom qui sera affiché dans les tableaux de bord d'énergie. Vous pourrez le changer plus tard si vous le souhaitez.
• consumption action : Laissez la valeur par défaut: sync

• production PRM : Votre numéro de PRM (14 chiffres) pour la production. Selon les cas, il peut être identique ou différent de celui qui gère la consommation.
• production token : Votre token Conso API correspondant au PRM de production
• production name : Choisissez le nom qui sera affiché dans les tableaux de bord d'énergie. Vous pourrez le changer plus tard si vous le souhaitez.
• production action : Laissez la valeur par défaut: sync

Appliquez les modifications et démarrez / redémarrez l'add-on si ce n'est pas déjà fait

Une fois l'add-on démarré, rendez-vous dans l'onglet Journal / Log pour suivre la progression de la synchronisation.

Au premier lancement, HA Linky essaiera de récupérer toutes les données de consommation depuis la date d'installation de votre compteur Linky.

Ensuite, il synchronisera les données deux fois par jour tant qu'il n'est pas arrêté :

• Une fois entre 6h et 7h du matin pour récupérer les données de la veille
• Une fois entre 9h et 10h du matin au cas où la première synchronisation a échoué

Vous pourrez vérifier le bon fonctionnement de l'add-on en vous rendant dans l'onglet Journal / Log, où toutes les informations utiles seront affichées.

Pour visualiser les données de HA Linky dans vos tableaux de bord d'énergie :

• Cliquez ici, ou ouvrez le menu Paramètres / Settings, puis Tableaux de bord / Dashboards, puis Énergie / Energy
• Dans la section Réseau électrique / Electricity grid, cliquez sur Ajouter une consommation / Add consumption
• Choisissez la statistique correspondant au consumption name ou production name que vous avez choisi à l'étape de configuration
• Cliquez sur Enregistrer / Save

• Les données d’une journée ne sont pas accessibles en temps réel, il faut attendre le lendemain de leur mesure pour pouvoir les récupérer, entre 6h et 10h.
• Pour les dates récentes (moins de 7 jours), HA Linky essaiera de récupérer en priorité des données par demi-heure
• Pour les dates plus anciennes, HA Linky récupèrera seulement des données quotidiennes. Vous verrez alors une seule grande barre entre 0h et 1h du matin sur votre tableau de bord d'énergie si vous affichez le graphique détaillé d'une telle journée.

En cas de problème, il est toujours possible d'effacer toutes les données de consommation ou de production créées par HA Linky

Revenez sur l'onglet Configuration de l'add-on et changez la valeur de consumption action (ou production action) à reset, puis appliquez les modifications et redémarrez l'add-on.

Ouvrez ensuite l'onglet Journal / Log pour vérifier que la remise à zéro s'est bien déroulée.

Au prochain démarrage, si consumption action (ou production action) est repassé à sync, HA Linky réimportera à nouveau toutes vos données. Cette manipulation peut surcharger le serveur de Conso API, ne l'utilisez donc que si nécessaire pour ne pas risquer un ban !

Si votre installation de Home Assistant ne vous permet pas d'accéder au système d'add-ons, il est également possible de lancer HA Linky en utilisant Docker

Construisez une image Docker ha-linky adaptée à votre système avec la commande suivante :

docker build https://github.com/bokub/ha-linky.git -f standalone.Dockerfile -t ha-linky

Créez ensuite un fichier nommé options.json, au format suivant, puis suivez les instructions du paragraphe "Configuration" ci-dessus pour le remplir.

{
  "consumption PRM": "",
  "consumption token": "",
  "consumption name": "Linky consumption",
  "consumption action": "sync",
  "production PRM": "",
  "production token": "",
  "production name": "Linky production",
  "production action": "sync"
}

Créez un jeton d'accès longue durée depuis la page de votre profil Home Assistant (accessible en cliquant sur vos initiales en bas du menu latéral)

Vous pouvez désormais lancer l'image Docker de HA Linky avec la commande docker run ou via Docker compose, selon vos préférences.

Dans les deux cas, remplacez :

• <options-folder> par le dossier contenant le fichier options.json
• <token> par le jeton d'accès Home Assistant que vous avez créé juste avant
• <ha-ip> par l'IP de votre instance Home assistant (avec le port si nécessaire)

# docker run
docker run -e SUPERVISOR_TOKEN='<token>' -e WS_URL='ws://<ha-ip>/api/websocket' -v <options-folder>:/data ha-linky

# docker-compose.yml
services:
  ha-linky:
    image: ha-linky
    environment:
      - SUPERVISOR_TOKEN=<token>
      - WS_URL=ws://<ha-ip>/api/websocket
    volumes:
      - <options-folder>:/data