Skip to content

Konkzor/LinKey

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo Linkey

CI codecov Firmware License: MIT Hardware License: CERN-OHL-W-2.0 ESP-IDF

Moniteur open-hardware basse consommation à base d'ESP32 pour le compteur électrique Linky (monophasé), avec intégration native à Home Assistant via MQTT.

LinKey (jeu de mot) lit la sortie série TIC (Télé-Information Client) d'un Linky monophasé et publie les mesures de puissance, d'énergie et de courant vers le broker MQTT de votre Home Assistant. Le coprocesseur ULP de l'ESP32 décode la trame TIC pendant que le CPU principal reste en light sleep, ce qui maintient une consommation moyenne suffisamment faible pour fonctionner sur l'alimentation de la TIC via une supercapa.

Fonctionnalités

  • Décodage UART 7E1 (1200 bauds) par le coprocesseur ULP de l'ESP32
  • Boucle principale en light sleep avec modem sleep WiFi
  • Publication MQTT en QoS 1, Last Will and Testament et auto-découverte Home Assistant
  • Alimentation par supercapa avec surveillance de tension intégrée
  • Retour visuel par LED RGB
  • Compatible contrats BASE, HP/HC, Tempo et EJP
  • Mode TIC historique (standard à venir)

Structure du dépôt

.
├── CAO/        Boîtier imprimable 3D (source STEP + modèle Onshape)
├── Doc/        Spécification TIC Linky et documents de référence
├── Firmware/   Projet ESP-IDF (ULP + machine d'état CPU, WiFi/MQTT)
└── PCB/        Projet KiCad, schéma, Gerbers

Documentation

Firmware

Le firmware est un projet ESP-IDF situé dans Firmware/. Consultez Firmware/README.md pour le guide complet de compilation, flashage et configuration.

Démarrage rapide :

git clone --recurse-submodules https://github.com/Konkzor/LinKey.git
cd LinKey/Firmware
source ~/esp/v5.4.1/esp-idf/export.sh
idf.py menuconfig    # Configurer vos credentials WiFi et MQTT
idf.py -p /dev/ttyUSB0 flash monitor

PCB

Le PCB a été réalisé sous KiCad 9.

Rendu 3D de la carte LinKey

Les sources de la carte se trouvent dans PCB/. Voir PCB/README.md pour une description des composants, le brochage de l'ESP32 et la connexion TIC.

Note : Les fichiers de fabrication et la nomenclature ne sont pas versionnés dans le repo. Ils sont disponibles en artefacts des jobs de la CI ainsi que dans la page Releases pour les versions taguées.

CAO

Le boîtier est conçu sous Onshape et imprimable en 3D.

Rendu 3D du boîtier LinKey v2

Les sources se trouvent dans CAO/. Voir CAO/README.md pour le lien vers le modèle Onshape et les paramètres d'impression conseillés.

  • Source CAO neutre (STEP) ;
  • Fichiers prêts à imprimer (3MF multicolore, STL mono-couleur) : page Releases.

Licence

Ce projet utilise une double licence selon la nature des fichiers :

Matériel — CERN-OHL-W-2.0

Le matériel (PCB/ : sources KiCad, Gerbers… et CAO/ : modèles 3D du boîtier, pièces mécaniques) est distribué sous CERN Open Hardware Licence Version 2 – Weakly Reciprocal (CERN-OHL-W-2.0).

Vous êtes libre d'utiliser, d'étudier, de modifier et de fabriquer ce matériel. Si vous modifiez les fichiers de conception eux-mêmes, vous devez publier ces modifications sous la même licence. En revanche, vous n'êtes pas tenu de publier les sources de produits plus larges qui ne font qu'incorporer cette conception.

Texte complet : LICENSE (EN).

Firmware — MIT

Le code du firmware (Firmware/main/) est distribué sous licence MIT, plus permissive et adaptée au logiciel.

Texte complet : Firmware/LICENSE (EN).

About

Une clé WIFI lisant la sortie TIC du Linky connectée au broker MQTT d'un Home Assistant

Topics

Resources

License

Stars

Watchers

Forks

Contributors