search

rene-d / wifinfo

Module Wi-Fi de téléinformation
https://rene-d.github.io/wifinfo/
14 stars 9 forks source link
arduino-esp8266 energy-monitor esp01 esp12 esp8266 nodemcu platformio teleinfo teleinformation

readme

WifInfo

PlatformIO CI Unit tests Codacy Badge codecov License: CC BY-NC-SA 4.0 Latest version

WifInfo est un module de consignation de la téléinformation des compteurs électriques 🇫🇷 avec serveur web embarqué.

Introduction

Ce projet est la fusion de développements réalisés en vue du remplacement d'un eco-devices sur base de Espressif 8266EX et de la une réécriture quasi complète - sauf la partie interface web - du projet homonyme de C-H. Hallard LibTeleinfo avec des modifications notamment de olileger et Doume.

Les notifications jeedom/emoncms ne sont pas testées.

Références

Documentation Enedis sur la téléinformation client pour les compteurs électroniques et pour les compteurs Linky.

Module PiTInfo et explications pourquoi le montage avec uniquement optocoupleur et résistances ne suffit pas avec un esp8266.

Interface web

Affichage des jauges PAPP, IINST et index HC/HP (en temps réel)

teleinfo

Affichage de données de téléinformation

teleinfo

Configuration des requêtes HTTP

Les requêtes HTTP sont de type GET.

Il y a 4 déclenchements possibles:

L'URI est constituée avec les étiquettes de téléinformation (ADCO, HCHC, HCHP, PTEC, PAPP, IINST, etc.) ainsi que des étiquettes internes:

La syntaxe pour utiliser les étiquettes est au choix:

Exemple: /update.php?ptec=$PTEC&conso=~HCHC~+~HCHP~&id=$chipid ⇒ /update.php?ptec=HP&conso=4000+3000&id=0x0011AA

Données JSON

Autres requêtes

Notifications SSE

Les événements SSE sont accessibles via deux URL: http://wifinfo/tic ou http://wifinfo/sse/json, avec une limitiation à deux clients simultatnés.

La donnée est la trame de téléinformation au format JSON, comme http://wifinfo/json.

Elle est envoyée à chaque réception de trame depuis le compteur.

Installation

Depuis la version 1.6, le projet utilise un autre système de fichiers que SPIFFS (code trop gourmand ~30Ko, et rajoute beaucoup d'overhead dans le filesystem). Les tailles du firmware et du filesystem empêchaient les mises à jour des modules avec 1Mo de mémoire flash.

Le projet automatiquement est compilé pour deux boards (Releases):

La programmation d'un module requiert des outils. esptool.py est l'outil officiel. L'IDE Arduino permet également de le faire.

Veuillez noter que chaque firmware est compilé pour une board précise, avec un plan d'adressage et une taille mémoire précises. Pour téléverser le programme avec l'IDE Arduino, il faut veiller à choisir la bonne carte et la bonne "Flash Size".

Programmation module 1 Mo :

esptool.py write_flash 0 firmware.bin
esptool.py write_flash 0xcb000 erfs.bin

Programmation module 4 Mo :

esptool.py write_flash 0 firmware.bin
esptool.py write_flash 0x300000 erfs.bin

Compilation

Le projet est conçu pour PlatformIO, en conjonction avec Visual Studio Code et son extension PlatformIO.

L'IDE d'Arduino peut également être utilisé.

La page HTML est compressée avec html-minifier et gzip.

Options de compilation

Nota: Sans l'option ENABLE_DEBUG, le port série est réglé à 1200 7E1 en RX uniquement. Il y a suffisamment d'outils de mise au point pour ne pas à devoir tester avec un compteur ou un autre microcontrôleur qui simule la téléinformation.

Génération du filesystem ERFS

Le filesystem est automatiquement construit par PlatformIO - même s'il s'appelle spiffs.bin, PlatformIO ne permet pas d'en changer le nom.

Les différentes étapes peuvent être reproduites indépendamment.

Le répertoire data est préparé à l'aide du script prep_data_folder.py (nécessite python3, gzip, html-minifier) :

python3 prep_data_folder.py

Le fichier binaire est assemblé par le script mkerfs32.py est l'outil utilisé.

# version 1Mo flash dont 192Ko de filesystem
python3 mkerfs32.py -c data -s 192k erfs.bin

# version 4Mo flash dont 1Mo de filesystem
python3 mkerfs32.py -c data -s 1000k erfs.bin

PlatformtIO

Avec PlatformIO (soit ligne de commandes, soit extension Visual Studio Code):

platformio run -e <carte> -t uploadfs
platformio run -e <carte> -t upload

Cf. platformio.ini pour l'environnement <carte>.

IDE Arduino

Cf. les nombreux tutos pour l'utilisation d'esp8266-arduino. Il sera aussi nécessaire de rajouter la librairie SimpleCLI.

Le script mkarduinosrc.py permet l'amalgamation du code source en un seul wifinfo.ino.

Ajout SimpleCLI:

SimpleCLI

Sélection de Flash Size pour module 1 Mo:

Flash Size

Client de test/mise au point

cli.py est un terminal série qui permet d'injecter de la téléinformation

pip3 install pyserial click
./cli.py

Pour activer le mode commande (si compilé avec l'option ENABLE_CLI), il faut taper ou puis la commande (ls, config, time, esp, ...).

sse.py est un client SSE. Lorsque WifInfo a un client connecté, il envoie toutes les trames reçues du compteur sur cette socket.

pip3 install sseclient click
./sse.py

Tests et couverture

Sans Docker:

mkdir -p build && cd build
cmake .. -DCODE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug -G Ninja
ninja
ninja test

Ou plus simplement:

./runtest.sh

L'installation de certains outils et librairies est nécessaire.

Avec Docker (tout est packagé dans l'image Docker):

docker build -t tic .
docker run --rm -ti -v $(pwd):/tic:ro -v $(pwd)/coverage:/coverage tic /tic/runtest.sh

La couverture est disponible dans ./coverage/index.html.

Développement de l'interface HTML

Avec module simulé (aucun esp8266 requis)

pip3 install flask flask-cors
python3 tools/srv.py

L'interface est alors disponible à cette adresse: http://localhost:5000/.

Avec module et partie web sur PC

nginx est utilisé en reverse proxy pour accéder aux pages dynamiques du module.

tools/httpdev.sh [adresse IP du module]

L'interface alors sera disponible à cette adresse: http://localhost:5001/, avec les requêtes dynamiques redirigées vers le module (qui doit donc être opérationnel et joignable).

Dashboard Grafana

La mise en place d'une stack sonde/InfluxDB/Grafana est grandement simplifiée grâce à Docker.

Le fichier docker-compose.yaml rassemble les trois services:

Il faudra configurer dans Grafana la source de données (http://influxdb:8086) et la database (teleinfo).

Le dashboard donné en exemple est celui créé par Antoine Emerit et légèrement modifié (calcul du coût dans le dashboard plutôt que dans la database).

On peut en créer facilement selon ses propres besoins ou envies.

WIFINFO=<adresse IP du module> docker-compose up -d

Le dashboard sera alors accessible à cette adresse: http://localhost:3000/.

dasboard

Montage

Le montage final utilise un ESP-01S avec le module PiTInfo - à acheter sur tindie. L'alimentation est assurée par un module USB.

teleinfo

Technologies utilisées

Développement

Tests unitaires & couverture

QA & CI/CD

Client de test/injecteur de téléinfo

Développement web

Développement web/vrai module

Client SSE

Dashboard Grafana+InfluxDB

Licence

Compte-tenu de la diversité d'origine des sources, ce travail est publié avec la licence de WifInfo sauf mention contraire.

Licence Creative Commons

Ce(tte) œuvre est mise à disposition selon les termes de la Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International.

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

SPDX-License-Identifier: CC-BY-NC-SA-4.0