StatsElec

StatsElec est une interface web permettant de suivre la consommation électrique d'un ou plusieurs compteurs électriques Enedis.

Lien d'accès à la documentation : https://statselec.readthedocs.io/fr/latest/

Pour suivre l'évolution du projet et de la milestone en cours (GitLab) : https://git.ahh.si/themimitoof/StatsElec/boards

Fonctionnalités

• Simple d'utilisation
• Compatible avec les compteurs Linky (mode historique uniquement) et les compteurs électroniques (CBEMM, CBEMM-ICC et CBETM)
• Compatible avec les installations monophasés et triphasés
• Compatible avec les tarifications base, heures creuses/heures pleines, EJP et Tempo
• Déploiement facile grâce à Docker et Docker compose !

Incompatibilitées

StatsElec est aujourd'hui incompatible avec les compteurs suivant :

• Linky en mode standard (nouveau contrat créé lors de la pose du compteur)
• EMERAUDE
• SAPHIR
• PME-PMI

Si vous possédez un de ses compteurs, envoyez-nous plusieurs trames afin d'intégrer le compteur à StatsElec !

Pré-requis

Nous recommandons fortement d'utiliser une machine Linux mais StatsElec fonctionne tout aussi bien sur les machines Windows.

Les pré-requis pour une installation sur Docker :

• Git
• Docker
• Docker-compose
• StatsElec-probe (bientôt disponible) ou bien du simulateur.

Pour les installations manuelles :

• Git
• NodeJS
• PostgreSQL
• Broker MQTT (nous recommandons Mosquitto car il est simple à configurer)
• StatsElec-probe (bientôt disponible) ou bien du simulateur.

Installation

Nous vous invitons à suivre le guide dans notre documentation : https://statselec.readthedocs.io/fr/latest/installation/

Note : Nous recommandons de déployer StatsElec dans Docker. Notre guide expliquera la démarche pour déployer sur Docker et non le déploiement manuel.

Une fois que vous avez télécherger le dépôt, naviguez dans le dossier config et créez une copie du fichier config.sample.js et renommez-le en config.js. La configuration pour Docker est déjà toute prête ! Si toutefois, vous souhaitez modifier des informations, pensez à bien changer les informations dans le fichier docker-compose.yml.

Dans le dossier racine de StatsElec, lancez la commande docker-compose build. Elle va créer l'image du conteneur StatsElec_Web. Une fois terminé, lancez la commande docker-compose up -d pour lancer l'ensemble des services.

Vous pouvez désormais entrer l'adresse http://localhost:8055 dans votre navigateur pour accéder à StatsElec.

Tests

Si vous souhaitez lancer les tests unitaires, tapez la commande docker-compose run --rm web npm run test (docker) ou npm run test (déploiement manuel).

Contributions

Si vous souhaitez contribuer à l'amélioration de StatsElec, nous vous invitons à fork le projet et de merge request vos travaux.

Si vous avez détecter un problème ou si vous souhaitez apporter une suggestion, ouvrez un ticket.

Licences