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 :
https://github.com/bokub/ha-linky
Une fois l'add-on installé, rendez-vous dans l'onglet Configuration.
La configuration YAML de base comporte 2 compteurs :
Vous pouvez effacer les lignes correspondant à la production si vous ne produisez pas d'électricité, ou rajouter d'autres compteurs si vous en avez besoin.
Pour chaque compteur, remplissez les champs suivants :
prm
: Votre numéro de PRM (14 chiffres).
"
, comme dans l'exemple ci-dessoustoken
: Votre token Conso APIname
: Choisissez le nom qui sera affiché dans les tableaux de bord d'énergie. Vous pourrez le changer plus tard si vous le souhaitez.action
: Laissez la valeur par défaut: sync
production
: Choisissez true
si le compteur gère la production d'énergie, false
sinonExemple de configuration pour un seul compteur, en consommation :
- prm: '18435095771264'
token: abcdef.ghijklmnopqrs.tuvwxyz
name: Consommation Linky
action: sync
production: false
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 jusqu'à 1 an de données historiques (sauf si vous fournissez votre propre export CSV).
Ensuite, il synchronisera les données deux fois par jour tant qu'il n'est pas arrêté :
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 :
name
que vous avez choisi à l'étape de configurationEn 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 action
à reset
sur le compteur qui vous intéresse, 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 action
est repassé à sync
, HA Linky réimportera à nouveau vos données historiques, soit via Conso API, soit via un fichier CSV si vous en avez fourni un (voir paragraphe suivant).
Lors de l'initialisation, HA Linky télécharge jusqu'à 1 an de données quotidiennes via Conso API.
Si vous souhaitez un historique plus long ainsi qu'une précision horaire, vous pouvez importer un fichier CSV à partir duquel HA Linky pourra extraire les données.
La démarche à suivre est la suivante :
/addon_configs/cf6b56a3_linky
(tutoriel)sync
et redémarrez l'add-onSi 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
[!NOTE] Cette méthode n'est pas recommandée et fait office de solution de dépannage pour les personnes ne voulant pas utiliser HAOS et son système d'add-ons.
Vous avez choisi d'installer Home Assistant avec une méthode "avancée", vous devriez donc maitriser vos outils. Je ne fournis pas d'aide concernant l'utilisation de Docker, Kubernetes, ou tout système autre que HAOS.
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.
{
"meters": [
{
"prm": "",
"token": "",
"name": "Linky consumption",
"action": "sync",
"production": false
},
{
"prm": "",
"token": "",
"name": "Linky production",
"action": "sync",
"production": true
}
]
}
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
<jeton>
par le jeton d'accès longue durée que vous avez créé juste avant dans Home Assistant<ha-ip>
par l'IP de votre instance Home assistant (avec le port si nécessaire)# docker run
docker run -e SUPERVISOR_TOKEN='<jeton>' -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=<jeton>
- WS_URL=ws://<ha-ip>/api/websocket
volumes:
- <options-folder>:/data
Pour importer des fichiers CSV (optionnel), rajoutez simplement un deuxième volume <csv-folder>:/config
où <csv-folder>
correspond au dossier contenant vos fichiers CSV.