Merge pull request #32 from 2hdlockness/dev V1.2.0

V1.2.0

Author: 2hdlockness

.eslint.config.mjs

@@ -112,7 +112,7 @@ const config = [
     }
   },
   {
-    "ignores": ["*.js"]
+    "ignores": ["*.js", "components/*.js"]
   }
 ];
 

.gitignore

@@ -1,4 +1,5 @@
 /node_modules/
 /MMM-Linky.js
 /node_helper.js
-/linkyData.json
+/components/
+/data/*.json

README.md

@@ -8,18 +8,19 @@ Si vous choisissez de récupérer les données de l'année précédente une comp
 
 Le header est également dynamique et changera en fonction de la période sélectionnée !
 
-Les données sont actualisées chaque jour entre 14h et 15h.
+Les données sont actualisées chaque jour entre 12h et 12h15.
 
 ## ScreenShots
 
-![Conso 7 derniers jours](https://github.com/user-attachments/assets/055eef27-43bb-478c-a2cb-16a451bac5b4)
-![Conso 3 derniers jours](https://github.com/user-attachments/assets/6dacfd38-d78e-4cb3-be22-be8aec980729)
-![Conso veille](https://github.com/user-attachments/assets/6e965953-0c5d-466e-accd-40d09ae3ab71)
+![APIs](https://github.com/user-attachments/assets/e3497a96-6a3a-4322-b9cb-fdd8bcfe9688)
+![Conso 7 derniers jours JPG](https://github.com/user-attachments/assets/fd2412cf-6cb1-4171-a3b7-1a9300ab2cc6)
+![Conso 3 derniers jours JPG](https://github.com/user-attachments/assets/c6658811-e6f4-4a5d-8e2c-ea0a53189fea)
+![Conso veille](https://github.com/user-attachments/assets/2e50eac0-71d2-44b4-9c78-0e9f4f1b80db)
 
 Possibilité de choisir entre 4 thèmes de couleur pour le graphique et d'afficher les valeurs dans les barres :
 
-![WithDataLabel](https://github.com/user-attachments/assets/a4196ed6-2289-487d-a4dc-aee6fb35ff06)
-![Capture](https://github.com/user-attachments/assets/52c76634-4543-41e0-be96-27326745fa3d)
+![WithDataLabel](https://github.com/user-attachments/assets/3ee608d5-3127-4adb-b6c3-2a3a07f6111e)
+![Capture](https://github.com/user-attachments/assets/a4d7366f-9f04-4a02-afaf-221caa9e1872)
 
 ## Installation
 
@@ -30,7 +31,7 @@ cd MMM-Linky
 npm run setup
 ```
 
-## Using the module
+## Utilisation du module
 
 ### Pré-requis
 
@@ -48,6 +49,8 @@ Pour utiliser ce module, ajoutez-le au tableau modules dans le fichier `config/c
         prm: "",
         token: "",
         periode: 1,
+        apis: ["getDailyConsumption"],
+        affichageInterval: 1000 * 15,
         annee_n_minus_1: 1,
         couleur: 3,
         valuebar: 1,
@@ -69,6 +72,7 @@ Configuration minimale :
       config: {
         prm: "",
         token: "",
+        apis: ["getDailyConsumption"]
       },
     },
 ```
@@ -77,18 +81,73 @@ Configuration minimale :
 
 Option|Default|Description
 ---|---|---
-`debug`|0|Active le mode débogage. <br>`1` : activer <br> `0` : Désactiver
+`debug`|0|Active le mode débogage. <br>`1` : activer <br> `0` : désactiver
 `prm`||Votre numéro PDL Linky [VOIR ICI](https://www.enedis.fr/faq/compteur-linky/ou-trouver-le-numero-point-de-livraison-pdl-du-compteur-linky)
-`token`||Votre token personnel  [CONSO API](https://conso.boris.sh/)
+`token`||Votre token personnel [CONSO API](https://conso.boris.sh/)
 `periode`|1|Choix de la période: <br>`1` = Données de la veille <br>`2` = 3 derniers jours <br>`3` = 7 derniers jours
-`annee_n_minus_1`|1|Récupérer les données de l'année précédente. <br>`1` : Activer <br> `0` : Désactiver
+`apis`|["getDailyConsumption"]|Nom des API à interroger (voir ci-dessous)
+`affichageInterval`|1000 * 15|Intervalle d'affichage des graphiques en ms (si utilisation de plusieurs API)
+`annee_n_minus_1`|1|Récupérer les données de l'année précédente. (uniquement pour les API `getDailyConsumption` et `getDailyProduction`) <br>`1` : activer <br> `0` : désactiver
 `couleur`|3| `1` : Bleu et Rose <br>`2` : Jaune et Vert <br>`3` : Blanc et Bleu <br>`4` : Orange et Violet
-`valuebar`|1|Affiche les valeurs à l'intérieur des barres. <br>`1` : Afficher <br>`0` : Masquer
-`valuebartextcolor`|0|Couleur du texte des valeurs. <br>`0` : Texte noir <br>`1` : Texte blanc
-`header`|1|Affiche l'en-tête selon la période selectionné. <br>`1` : Afficher <br>`0` : Masquer
-`energie`|1|Affiche l'indicateur de consomation d'énergie. <br>`1` : Afficher <br>`0` : Masquer
-`updateDate`|1|Affiche la date de récupération des données. <br>`1` : Afficher <br>`0` : Masquer
-`updateNext`|1|Affiche la date du prochain cycle de récupération des données. <br>`1` : Afficher <br>`0` : Masquer
+`valuebar`|1|Affiche les valeurs à l'intérieur des barres. <br>`1` : afficher <br>`0` : masquer
+`valuebartextcolor`|0|Couleur du texte des valeurs. <br>`0` : texte noir <br>`1` : texte blanc
+`header`|1|Affiche l'en-tête selon la période selectionné. <br>`1` : afficher <br>`0` : masquer
+`energie`|1|Affiche l'indicateur de consomation d'énergie. <br>`1` : afficher <br>`0` : masquer
+`updateDate`|1|Affiche la date de récupération des données. <br>`1` : afficher <br>`0` : masquer
+`updateNext`|1|Affiche la date du prochain cycle de récupération des données. <br>`1` : afficher <br>`0` : masquer
+
+### APIs
+
+Grâce à `Conso API`, vous pouvez interroger plusieurs API et afficher le graphique correspondant.
+
+* `getDailyConsumption`: Récupère la consommation quotidienne.
+* `getLoadCurve`: Récupère la puissance moyenne consommée de la veille sur un intervalle de 30 min.
+* `getMaxPower`: Récupère la puissance maximale de consommation atteinte quotidiennement.
+
+Il est également possible d'afficher vos données de production d'energie.
+
+* `getDailyProduction`: Récupère la production quotidienne.
+* `getProductionLoadCurve`: Récupère la puissance moyenne produite sur un intervalle de 30 min.
+
+## Mise en cache des données
+
+Afin d'éviter une surcharge de l'API, une mise en cache des données a été mise en place.
+
+De ce fait, lors d'un redémarrage de `MagicMirror²`, `MMM-Linky` utilisera les dernières données reçues de l'API.
+
+La validité de ce cache à été fixée à 10h.
+
+## Effacer le cache des données
+
+Vous pouvez toute fois détruire ce cache avec la commande: `npm run reset:cache`
+
+Il est déconseillé d'utiliser cette commande trop souvent car l'api a un usage limité.
+
+`Conso API` a fixé cette régle:
+
+* Maximum de 5 requêtes par seconde.
+* Maximum de 10 000 requêtes par heure.
+
+⚠ Si vous dépassez une des régles, votre adresse IP sera bloquée sans avertissement !
+
+Malheurement, nous n'avons aucun pouvoir pour la débloquer...
+
+Pour rappel un appel API est une requête. si vous utilisez 2 API en config... c'est donc 2 requêtes !
+
+## Changement de configuration
+
+Afin de générer un nouveau cache, une nouvelle requête sera relancé pour les API suivantes (si utilisées)
+
+↪️ En cas de changement de configuration `periode`
+
+* `getDailyConsumption`
+* `getMaxPower`
+* `getDailyProduction`
+
+↪️ En cas de changement de configuration `annee_n_minus_1`
+
+* `getDailyConsumption`
+* `getDailyProduction`
 
 ## Mise à jour
 

data/.keep

@@ -0,0 +1,21 @@
+const utils = require("./utils");
+
+async function main () {
+  // Let's start !
+  utils.empty();
+  utils.info(`Delete Cache ${utils.moduleName()} v${utils.moduleVersion()}`);
+  utils.empty();
+  await deleteCache();
+  utils.success("Done!");
+}
+
+async function deleteCache () {
+  utils.info("➤ Cleaning json data files...");
+  if (utils.isWin()) {
+    await utils.execCMD(`del ${utils.getModuleRoot()}\\data\\*.json`);
+  } else {
+    await utils.execCMD(`rm -f ${utils.getModuleRoot()}/data/*.json`);
+  }
+}
+
+main();

installer/cache.js

@@ -1,3 +1,4 @@
+const path = require("node:path");
 const utils = require("./utils");
 
 var packageJSON;
@@ -12,6 +13,8 @@ try {
 var options = packageJSON.installer || {};
 
 async function updatePackageInfoLinux () {
+  const apt = options.apt;
+  if (!apt.length) return;
   utils.empty();
   utils.info("➤ Update package informations");
   utils.empty();
@@ -34,14 +37,13 @@ async function updatePackageInfoLinux () {
 module.exports.updatePackageInfoLinux = updatePackageInfoLinux;
 
 async function installLinuxDeps () {
+  const apt = options.apt;
+  if (!apt.length) return;
   utils.empty();
   utils.info("➤ Dependencies installer");
   utils.empty();
-  const apt = options.apt;
-  if (!apt.length) {
-    utils.out("No dependecies needed!");
-    return;
-  }
+  utils.out(`Checking: ${apt}...`);
+  utils.empty();
   return new Promise((resolve) => {
     utils.check(apt, (result) => {
       if (!result.length) {
@@ -70,6 +72,32 @@ async function installLinuxDeps () {
 }
 module.exports.installLinuxDeps = installLinuxDeps;
 
+async function postInstall () {
+  if (!options.postInstall) return;
+  utils.empty();
+  utils.info("➤ Post-Install...");
+  utils.empty();
+  const Path = path.resolve(`${utils.getModuleRoot()}`, "installer");
+  const args = utils.getArgs();
+  const command = args.path ? `${options.postInstall} --path=${args.path}` : `${options.postInstall}`;
+  return new Promise((resolve) => {
+    utils.execPathCMD(command, Path, (err) => {
+      if (err) {
+        utils.error("Error Detected!");
+        process.exit(1);
+      }
+      resolve();
+    })
+      .on("stdout", function (data) {
+        utils.out(data.trim());
+      })
+      .on("stderr", function (data) {
+        utils.error(data.trim());
+      });
+  });
+}
+module.exports.postInstall = postInstall;
+
 async function installNPMDeps () {
   utils.empty();
   utils.info("➤ NPM Package installer");
@@ -141,13 +169,10 @@ async function develop () {
 module.exports.develop = develop;
 
 async function electronRebuild () {
+  if (!options.rebuild || (utils.isWin() && !options.windowsRebuild)) return;
   utils.empty();
   utils.info("➤ Rebuild MagicMirror...");
   utils.empty();
-  if (!options.rebuild || (utils.isWin() && !options.windowsRebuild)) {
-    utils.out("electron-rebuild is not needed.");
-    return;
-  }
   return new Promise((resolve) => {
     utils.electronRebuild((err) => {
       if (err) {
@@ -209,6 +234,7 @@ function setOptions () {
     minify: true,
     rebuild: false,
     apt: [],
+    postInstall: null,
     windowsNPMRemove: [],
     windowsRebuild: false
   };

installer/functions.js

@@ -25,7 +25,11 @@ async function checkOS () {
       }
       utils.empty();
       await utils.checkRoot();
+      await functions.updatePackageInfoLinux();
+      await functions.installLinuxDeps();
       await functions.installNPMDeps();
+      await functions.postInstall();
+      await functions.electronRebuild();
       await functions.installFiles();
       functions.done();
       break;
@@ -38,6 +42,7 @@ async function checkOS () {
     case "Windows":
       utils.success(`OS Detected: Windows (${sysinfo.name} ${sysinfo.version} ${sysinfo.arch})`);
       await functions.installNPMDeps();
+      await functions.postInstall();
       await functions.installFiles();
       functions.done();
       break;

installer/setup.js

@@ -9,6 +9,7 @@ var packageJSON = require("../package.json");
 
 var moduleRoot = path.resolve(__dirname, "../");
 const installerHome = path.resolve(__dirname, "../installer");
+const bugsounetRoot = path.resolve(__dirname);
 
 // color codes
 const reset = "\x1B[0m";
@@ -353,7 +354,8 @@ module.exports.develop = develop;
 // electron need to be rebuilded
 function electronRebuild (callback = () => {}) {
   var emitter = new events.EventEmitter();
-  var child = exec("npx electron-rebuild", { cwd: moduleRoot }, function (err) {
+  const cmd = args.path ? `npx electron-rebuild -m ${moduleRoot}` : "npx electron-rebuild";
+  var child = exec(cmd, { cwd: bugsounetRoot }, function (err) {
     if (err) {
       return callback(err);
     }
@@ -392,6 +394,27 @@ function execCMD (command, callback = () => {}, bypass) {
 }
 module.exports.execCMD = execCMD;
 
+function execPathCMD (command, path, callback = () => {}) {
+  var emitter = new events.EventEmitter();
+  var child = exec(`${command}`, { cwd: path }, function (err) {
+    if (err) {
+      return callback(err);
+    }
+    return callback();
+  });
+
+  child.stdout.on("data", function (data) {
+    emitter.emit("stdout", data);
+  });
+
+  child.stderr.on("data", function (data) {
+    emitter.emit("stderr", data);
+  });
+
+  return emitter;
+}
+module.exports.execPathCMD = execPathCMD;
+
 async function moduleReset () {
   info("➤ Cleaning js files and reset git branch...");
   if (isWin()) {