xouillet/lixeeticdin

Linky (LiXee-TIC-DIN) support for Home Assistant

Support du compteur Linky dans Home Assistant

Cette intégration pour Home Assistant ajoute le support des Linky au travers de n'importe quelle connection série en provenance du module TIC (Télé Information Client) du compteur Linky.

Par exemple:

• Module série USB développé par LiXee (celui que j'utilise)
• Téléinfo 1 compteur USB rail DIN de Cartelectronic (validé par un utilisateur)
• Circuit à faire soi-même, nécessitant peu de composants (autre article avec un circuit similaire). Validé par un utilisateur.
• et certainement bien d'autres ! (n'hésitez pas à m'ouvrir une issue pour rajouter le votre si vous avez validé que celui-ci fonctionne avec cette intégration afin d'aidez de potentiels futurs utilisateurs qui n'en auraient pas encore choisi un)

Exemple sous Home Assistant.

Théoriquement cette intégration est compatible avec les compteurs pré Linky qui possèdent un module TIC en choisissant le mode historique. Mais n'en ayant aucun dans mon entourage, je n'ai pas pu le vérifier.

Informations remontées

Cette intégration va lire de manière continue les informations envoyées sur le TIC et stocker en mémoire la dernière valeur lue pour chacun des compteurs. Ensuite, Home Assistant viendra régulièrement lui même "récolter" les valeurs des différents sondes que l'intégration lui a déclaré. La fréquence observée semble être de 30 secondes. C'est largement suffisement pour la très grande majoritée des sondes.

Cependant, certaines sondes peuvent avoir de la valeur dans leur "instantanéité" (relative). Pour cela, l'intégration possède une option "temps réel" qui peut être activée. Celle-ci ne passera pas toutes les sondes en temps réel mais seulement celles pour qui cela peut avoir du sens (voir ci-dessous). Cette option temps réel notifiera Home Assistant qu'une nouvelle valeure est prête à être lue et lui demandera de venir la lire (et l'enregistrer) au plus vite à la différence des autres sondes dont les valeurs sont récupérées par Home Assistant, à son rythme.

Suivant la configuration que vous choisirez pour votre installation vous trouverez dans ce fichier dans la liste des sondes avec les annotations suivantes:

• ¹ sonde compatible avec le mode temps réel: si celui-ci est activé par l'utilisateur, les mises à jours seront bien plus fréquentes (dès qu'elles sont lues sur la connection série)
• ² sonde dont le mode temps réel est forcé même si l'utilisateur n'a pas activé le mode temps réèl dans le cas où la valeur de la sonde est importante et/ou éphémère

Mode historique

Le mode historique est le plus commun (existant pré Linky) : il est activé par défault à moins que vous soyez producteur d'énergie.

Compteurs mono-phasé

Les 23 champs des compteurs mono-phasé configurés en mode historique sont supportés:

• ADCO Adresse du compteur (avec parsing EURIDIS en attributs étendus et périphérique agrégateur sous Home Assistant)
• OPTARIF Option tarifaire choisie
• ISOUSC Intensité souscrite
• BASE Index option Base
• HCHC Index option Heures Creuses - Heures Creuses
• HCHP Index option Heures Creuses - Heures Pleines
• EJPHN Index option EJP - Heures Normales
• EJPHPM Index option EJP - Heures de Pointe Mobile
• BBRHCJB Index option Tempo - Heures Creuses Jours Bleus
• BBRHPJB Index option Tempo - Heures Pleines Jours Bleus
• BBRHCJW Index option Tempo - Heures Creuses Jours Blancs
• BBRHPJW Index option Tempo - Heures Pleines Jours Blancs
• BBRHCJR Index option Tempo - Heures Creuses Jours Rouges
• BBRHPJR Index option Tempo - Heures Pleines Jours Rouges
• PEJP Préavis Début EJP (30 min)
• PTEC Période Tarifaire en cours
• DEMAIN Couleur du lendemain
• IINST Intensité Instantanée ¹
• ADPS Avertissement de Dépassement De Puissance Souscrite ²
• IMAX Intensité maximale appelée
• PAPP Puissance apparente ¹
• HHPHC Horaire Heures Pleines Heures Creuses
• MOTDETAT Mot d'état du compteur

Compteurs tri-phasés

⚠️ Actuellement en beta ⚠️

• ADCO Adresse du compteur (avec parsing EURIDIS en attributs étendus et périphérique agrégateur sous Home Assistant)
• OPTARIF Option tarifaire choisie
• ISOUSC Intensité souscrite
• BASE Index option Base
• HCHC Index option Heures Creuses - Heures Creuses
• HCHP Index option Heures Creuses - Heures Pleines
• EJPHN Index option EJP - Heures Normales
• EJPHPM Index option EJP - Heures de Pointe Mobile
• BBRHCJB Index option Tempo - Heures Creuses Jours Bleus
• BBRHPJB Index option Tempo - Heures Pleines Jours Bleus
• BBRHCJW Index option Tempo - Heures Creuses Jours Blancs
• BBRHPJW Index option Tempo - Heures Pleines Jours Blancs
• BBRHCJR Index option Tempo - Heures Creuses Jours Rouges
• BBRHPJR Index option Tempo - Heures Pleines Jours Rouges
• PEJP Préavis Début EJP (30 min)
• PTEC Période Tarifaire en cours
• DEMAIN Couleur du lendemain
• IINST1 Intensité Instantanée (phase 1) ¹ pour les trames longues ² pour les trames courtes
• IINST2 Intensité Instantanée (phase 2) ¹ pour les trames longues ² pour les trames courtes
• IINST3 Intensité Instantanée (phase 3) ¹ pour les trames longues ² pour les trames courtes
• IMAX1 Intensité maximale (phase 1)
• IMAX2 Intensité maximale (phase 2)
• IMAX3 Intensité maximale (phase 3)
• PMAX Puissance maximale triphasée atteinte
• PAPP Puissance apparente ¹
• HHPHC Horaire Heures Pleines Heures Creuses
• MOTDETAT Mot d'état du compteur
• ADIR1 Avertissement de Dépassement d'intensité de réglage (phase 1) ² trames courtes uniquement
• ADIR2 Avertissement de Dépassement d'intensité de réglage (phase 2) ² trames courtes uniquement
• ADIR3 Avertissement de Dépassement d'intensité de réglage (phase 3) ² trames courtes uniquement

Mode standard

Le mode standard peut être considéré comme la "v2" du TIC développé par Enedis et a été introduit avec les Linky. Il transmets plus d'informations mais n'est activé qu'à la demande de l'utilisateur ou si celui-ci est producteur d'énergie. Le mode standard n'est pour le moment pas supporté même si j'envisage d'y passer moi même pour pouvoir le développer. Le coeur du module (lecture série du TIC) est théoriquement déjà compatible avec ce mode mais pas les entités Home Assistant (voir la partie Architecture).

Installation

Configuration du module

Une fois que votre module TIC est installé et connecté à votre compteur ainsi qu'un votre box domotique au travers de son cable USB, vous devriez voir apparaitre le périphérique /dev/ttyUSB0 (ou /dev/ttyUSB1 si vous aviez déjà une /dev/ttyUSB0).

Exemple de configuration pour le module de LiXee:

• Mode historique

stty -F /dev/ttyUSB0 1200 sane evenp parenb cs7 -crtscts

• Mode standard (à vérifier)

stty -F /dev/ttyUSB0 9600 sane evenp parenb cs7 -crtscts

Vérifiez que celui-ci fonctionne correctement en lancant la commande (Ctrl+C pour quitter):

cat /dev/ttyUSB0

Vous devriez voir défiler les informations du TIC.

Téléchargement

Dans la page des releases sélectionnez la version que vous souhaitez et copiez l'adresse de l'archive zip.

Ensuite rendez vous dans votre dossier config (celui ou le fichier configuration.yaml est présent) de Home Assistant et créez le dossier custom_components s'il n'existe pas déjà. Entrez à l'intérieur de celui-ci et téléchargez l'archive zip. Enfin décompressez la.

config_dir="/remplacez/par/le/votre"
mkdir -p "${config_dir}/custom_components"
cd !$
wget "<url_du_zip>" -O 'linky_tic.zip'
unzip 'linky_tic.zip'
rm -r 'linkytic' # seulement si vous aviez une précédente version du module
mv 'linkytic-<version_du_zip>' 'linkytic'

Remplacez toutes les valeurs entre <...>.

Vous devriez maintenant avoir le dossier /votre/config/dir/custom_components/linkytic.

Redémarrez votre Home Assistant !

Migration depuis la v1

L'intégration ayant changée de nom, n'oubliez pas d'enlever le bloc

lixeeticdin:
  # [...]

de votre fichier configuration.yaml avant de redémarrer Home Assistant (ou redémarrez le une nouvelle fois).

Activation et configuration dans Home Assistant

Une fois redémarré, allez dans: Paramètres -> Appareils et services -> Ajouter une intégration. Dans la fenêtre modale qui s'ouvre, cherchez linky et sélectionnez l'intégration s'appelant Linky TIC dans la liste (une petite icône d'un carton ouvert avec un texte de survol indiquant Fourni par une extension personnalisée devrait se trouver sur la droite).

Vous devriez passer sur le formulaire d'installation vous présentant les 3 champs suivants:

• Chemin/Adresse vers le périphérique série Ici renseignez le path de votre périphérique USB testé précédement. Le champ est rempli par default avec la valeur /dev/ttyUSB0: Il ne s'agit pas d'une auto détection mais simplement de la valeure la plus probable dans 99% des installations. Il est aussi possible d'utiliser une URL supporté par pyserial, ce qui peut s'avérer utile si le port série est connecté sur un appareil distant (support de la rfc2217 par exemple).
• Mode TIC Choississez entre Standard et Historique. Plus de détails sur ces 2 modes en début de ce document.
• Triphasé À cocher si votre compteur est un compteur... triphasé. À noter que cette option n'a d'effet que si vous êtes en mode historique (le mode standard gère le mono et le tri de manière indifférente).

Validez et patientez pendant le temps du test. Celui-ci va tenter d'ouvrir une connection série sur le périphérique désigné et d'y lire au moins une ligne. En cas d'erreur, celle-ci vous sera retourné à l'écran de configuration. Sinon, votre nouvelle intégration est prête et disponible dans la liste des intégrations de la page où vous vous trouvez.

Pour ceux intéressé par le mode "temps réel", localisez l'intégration Linky TIC dans les tuiles de la page et cliquez sur Configurer.

Migration depuis la v1

Le passage au config flow permettant notamment l'installation, la configuratione et la suppression depuis l'interface grahique directement plutôt qu'en passant par le fichier de configuration YAML (méthode dépréciée par Home Assistant et utilisé par la v1) a entrainé un changement en profondeur: chaque identifiant unique des sondes (une valeur interne que vous ne voyez pas) a dû changer pour s'accomoder à la partie dynamique du control flow.

Cela veut dire qu'en passant de la v1 à la v2 (vous avez bien pensez à retirer la déclaration de l'ancien nom de la v1 dans votre fichier de configuration YAML ?) de nouvelles sondes vont être crées. Il est toute fois possible de faire un peu de ménage et de rattacher ces nouvelles sondes sur les anciens ID utilisateurs afin de conserver leur historique.

Possible mais fastidieux, à vous de voir:

• Une fois la v2 installée et configurée
• Depuis la tuile de l'intégration dans Paramètres -> Appareils et services, dirigez vous vers l'onglet Entités et faites une recherche avec Linky
• Vous devriez alors voir vos précédents sondes de l'intégration lixeeticdin et la nouvelle v2 Linky TIC".
• Par exemple pour la sonde de la puissance apparante:
  • sensor.linky_puissance_apparente liée à la v1
  • sensor.linky_puissance_apparente_2 liée à la v2
• Cliquez sur celle de la v1 et supprimez là avec le bouton en bas à gauche
• Tout de suite après, cliquez sur celle de la v2 et renommez l'ID Entité de sensor.linky_puissance_apparente_2 en sensor.linky_puissance_apparente
• Répétez l'oppération pour toutes les entitées (courage !)

Développement

Disclaimer

Je ne suis pas un habitué du python et encore moins du framework Home Assistant ! Ce module doit donc être largement améliorable. Néanmoins il permet le support simple et natif d'un maximum d'éléments transmis par le compteur Linky dans Home Assistant au travers d'une connection série du TIC dont certains en temps réel.

Architecture

Référence

Le document de référence du protocole TIC dévelopé par Enedis est archivé dans ce repo. Vous y trouverez toutes les informations nécessaire au dévelopement ainsi que des détails sur les informations remontées par ce plugin. Celui-ci et tout autre document de référence d'implémentation pouvant se trouver dans ce répertoire ne sont évidement pas couvert par la license MIT de ce repo et reste la propriété de leurs auteurs respectifs.