Merge pull request #3 from rene-d/develop

correction paramètre cfg_led_tinfo

Author: rene-d

README.md

@@ -4,7 +4,7 @@ WifInfo est un module de consignation de la téléinformation des compteurs éle
 
 ## Introduction
 
-Ce projet est la fusion de développements réalisés en vue du remplacement d'un [eco-devices](http://gce-electronics.com/fr/111-eco-devices) sur base de [ESP-01](https://fr.wikipedia.org/wiki/ESP8266) et de la une réécriture quasi complète - sauf la partie interface web - du projet homonyme de C-H. Hallard [LibTeleinfo](https://github.com/hallard/LibTeleinfo) avec des modifications notamment de [olileger](https://github.com/olileger/LibTeleinfo) et [Doume](https://github.com/Doume/LibTeleinfo).
+Ce projet est la fusion de développements réalisés en vue du remplacement d'un [eco-devices](http://gce-electronics.com/fr/111-eco-devices) sur base de [ESP-01](https://fr.wikipedia.org/wiki/ESP8266) et de la une réécriture quasi complète - sauf la partie interface web - du projet homonyme de [C-H. Hallard](http://hallard.me) [LibTeleinfo](https://github.com/hallard/LibTeleinfo) avec des modifications notamment de [olileger](https://github.com/olileger/LibTeleinfo) et [Doume](https://github.com/Doume/LibTeleinfo).
 
 * Meilleure séparation des fonctions dans des fichiers sources différents
 * Homogénéisation du nommage, nettoyage du code source
@@ -19,12 +19,68 @@ Ce projet est la fusion de développements réalisés en vue du remplacement d'u
 * Exemple de stack [InfluxDB](https://www.influxdata.com) + [Grafana](https://grafana.com) pour la visualisation des données (avec sonde Python et client SSE)
 * Utilisation de [PlatformIO](https://platformio.org) comme environnement de développement
 
-## Documentation
+La mise à jour OTA et les notifications jeedom/emoncms ne sont pas testées.
+
+## Références
 
 Documentation ERDF sur la [téléinformation client](https://www.enedis.fr/sites/default/files/Enedis-NOI-CPT_02E.pdf) pour les compteurs électroniques et pour les compteurs [Linky](https://www.enedis.fr/sites/default/files/Enedis-NOI-CPT_54E.pdf).
 
 Module [PiTInfo](https://hallard.me/pitinfov12/) et explications pourquoi le montage avec uniquement optocoupleur et résistances ne suffit pas avec un esp8266.
 
+## Interface web
+
+### Affichage des jauges PAPP et IINST (en temps réel)
+
+![teleinfo](docs/gauges.png)
+
+### Affichage de données de téléinformation
+
+![teleinfo](docs/teleinfo.png)
+
+### Configuration des requêtes HTTP
+
+Les requêtes HTTP sont de type GET.
+
+Il y a 4 déclenchements possibles:
+* périodique
+* lors d'un changement de période tarifaire (exemple passage de HP à HC)
+* lors de dépassement d'un seuil haut ou retour à un seuil bas (en VA, test avec la valeur PAPP)
+* présence de l'étiquette ADPS (Avertissement de Dépassement de Puissance Souscrite)
+
+L'URI est constituée avec les étiquettes de téléinformation (`ADCO`, `HCHC`, `HCHP`, `PTEC`, `PAPP`, `IINST`, etc.) ainsi que des étiquettes internes:
+* date : date au format ISO8601 (ex: 2020-02-02T12:12:00+0100)
+* timestamp : temps en secondes (Unix epoch)
+* chipid : l'identifiant de l'esp8266 sous forme hexadécimale (0x0011AA)
+* type : type de déclenchement (`MAJ`: périodique, `PTEC`: changement tarif, `HAUT`: seuil haut, `BAS`: retour seuil bas, `ADPS`: dépassement, `NORM`: fin dépassement)
+
+La syntaxe pour utiliser les étiquettes est au choix:
+* `$NOM`
+* `~NOM~`
+
+Exemple: `/update.php?ptec=$PTEC&conso=~HCHC~+~HCHP~&id=$chipid` ⇒ `/update.php?ptec=HP&conso=4000+3000&id=0x0011AA`
+
+### Données JSON
+
+* http://wifinfo/json : téléinformation sous forme de dictionnaire JSON
+* http://wifinfo/tinfo.json : téléinformation sous forme de tableau JSON, utilisé par l'onglet Téléinformation de l'interface
+* http://wifinfo/system.json : état du système, utilisé par l'onglet Système de l'interface
+* http://wifinfo/config.json : état du système, utilisé par l'onglet Configuration de l'interface
+* http://wifinfo/wifiscan.json : liste des réseaux Wi-Fi, utilisé par l'onglet Configuration de l'interface
+* http://wifinfo/spiffs.json : liste des fichiers, utilisé par l'onglet Fichiers de l'interface
+
+### Autres requêtes
+
+* http://wifinfo/reset : permet de redémarrer le module
+* http://wifinfo/version : retourne la version (tag git) du système de fichiers
+
+### Client SSE
+
+Le événements SSE sont accessibles via deux URL: http://wifinfo/tic ou http://wifinfo/sse/tinfo.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.
+
 ## Compilation
 
 Le projet est prévu pour PlatformIO sous macOS ou Linux, en conjonction avec [Visual Studio Code](https://code.visualstudio.com) et son extension [PlatformIO](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide).
@@ -33,6 +89,16 @@ L'IDE d'Arduino peut également être utilisé.
 
 La page HTML est compressée avec [html-minifier](https://github.com/kangax/html-minifier) et gzip.
 
+
+### Options de compilation
+
+* `DEBUG` : active la sortie sur le port série TX et vitesse 115200. Non utilisable avec un compteur, il faut utiliser le client de test pour injecter des trames.
+* `ENABLE_CLI` : active les commandes par port série (`TAB` ou `ESC`)
+* `DISABLE_LED` : désactive l'utilisation de LED pour les cartes qui n'en ont pas
+* `ENABLE_OTA` : rajoute le code pour les mises à jour OTA **(non testé)**
+
+Nota: Sans l'option `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.
+
 ### PlatformtIO
 
 Avec PlatformIO (soit ligne de commandes, soit extension Visual Studio Code):
@@ -44,7 +110,7 @@ platformio run -t upload
 
 ### IDE Arduino
 
-Cf. les nombreux tutos pour l'utilisation d'esp8266-arduino et l'upload de SPIFFS.
+Cf. les nombreux tutos pour l'utilisation d'esp8266-arduino et l'upload de SPIFFS. Il sera aussi nécessaire de rajouter la librairie SimpleCLI.
 
 Le répertoire `data` est préparé à l'aide du script suivant (nécessite python3, gzip, html-minifier) :
 
@@ -92,7 +158,7 @@ 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`
+La couverture est disponible dans `./coverage/index.html`.
 
 ## Développement web
 
@@ -141,7 +207,7 @@ Le dashboard sera alors accessible à cette adresse: [http://localhost:3000/](ht
 
 Le montage final utilise un ESP-01S avec le module [PiTInfo](http://hallard.me/pitinfov12-light/) - à acheter sur [tindie](https://www.tindie.com/products/Hallard/pitinfo/). L'alimentation est assurée par un module USB.
 
-![teleinfo](docs/teleinfo.jpg)
+![teleinfo](docs/montage.jpg)
 
 ## Technologies utilisées
 

dashboard/wifinfo_sse/influx.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # rene-d 2020
 
-# dashboard:
+# à utiliser avec un dashboard comme celui-ci:
 #   https://www.kozodo.com/blog/techno/article.php?id=32
 
 """
@@ -17,7 +17,7 @@
 import click
 
 
-# Tarifs EDF réglementés fin 2019
+# Tarifs réglementés EDF fin 2019
 
 # TVA à 5.5%
 ABO = 17.16  # Heures Creuses - 06kVA
@@ -89,14 +89,13 @@ def main(frequency, wifinfo_addr, influxdb_addr):
                 "tags": {"host": data["ADCO"]},
                 "time": data["timestamp"],
                 "fields": {
-                    "COSTHC": data["HCHC"] / 1000 * tarif_hc_ttc,
-                    "COSTHP": data["HCHP"] / 1000 * tarif_hp_ttc,
+                    "COSTHC": round(data["HCHC"] / 1000 * tarif_hc_ttc, 4),
+                    "COSTHP": round(data["HCHP"] / 1000 * tarif_hp_ttc, 4),
                     "HCHC": data["HCHC"],
                     "HCHP": data["HCHP"],
                     "PAPP": data["PAPP"],
                     "IINST": data["IINST"],
-                    "IMAX": data["IMAX"],
-                    "PTEC": data["PTEC"][:2],
+                    "PTEC": data["PTEC"],
                 },
             }
         ]

docs/gauges.png

@@ -87,9 +87,9 @@ void config_reset()
     strcpy_P(config.jeedom.adco, CFG_JDOM_DEFAULT_ADCO);
 
     // HTTP Request
-    strcpy_P(config.httpReq.host, CFG_HTTPREQ_DEFAULT_HOST);
-    config.httpReq.port = CFG_HTTPREQ_DEFAULT_PORT;
-    strcpy_P(config.httpReq.url, CFG_HTTPREQ_DEFAULT_URL);
+    strcpy_P(config.httpreq.host, CFG_HTTPREQ_DEFAULT_HOST);
+    config.httpreq.port = CFG_HTTPREQ_DEFAULT_PORT;
+    strcpy_P(config.httpreq.url, CFG_HTTPREQ_DEFAULT_URL);
 
     // save back
     config_save();
@@ -204,7 +204,7 @@ void config_show()
     Serial.println(config.ota_port);
 
     Serial.print(F("Config   :"));
-    if (config.config & CONFIG_LED_TINFO)
+    if (config.options & OPTION_LED_TINFO)
         Serial.print(F(" LED_TINFO"));
     Serial.println();
 
@@ -238,25 +238,25 @@ void config_show()
 
     Serial.println(F("===== HTTP request"));
     Serial.print(F("host      : "));
-    Serial.println(config.httpReq.host);
+    Serial.println(config.httpreq.host);
     Serial.print(F("port      : "));
-    Serial.println(config.httpReq.port);
+    Serial.println(config.httpreq.port);
     Serial.print(F("url       : "));
-    Serial.println(config.httpReq.url);
+    Serial.println(config.httpreq.url);
     Serial.print(F("freq      : "));
-    Serial.println(config.httpReq.freq);
+    Serial.println(config.httpreq.freq);
     Serial.print(F("notifs    :"));
-    if (config.httpReq.trigger_ptec)
+    if (config.httpreq.trigger_ptec)
         Serial.print(F(" PTEC"));
-    if (config.httpReq.trigger_adps)
+    if (config.httpreq.trigger_adps)
         Serial.print(F(" ADPS"));
-    if (config.httpReq.trigger_seuils)
+    if (config.httpreq.trigger_seuils)
         Serial.print(F(" seuils"));
     Serial.println();
     Serial.print(F("seuil bas : "));
-    Serial.println(config.httpReq.seuil_bas);
+    Serial.println(config.httpreq.seuil_bas);
     Serial.print(F("seuil haut: "));
-    Serial.println(config.httpReq.seuil_haut);
+    Serial.println(config.httpreq.seuil_haut);
 
     Serial.flush();
 }
@@ -274,7 +274,7 @@ void config_get_json(String &r)
     js.append(CFG_FORM_OTA_AUTH, config.ota_auth);
     js.append(CFG_FORM_OTA_PORT, config.ota_port);
 
-    js.append(FPSTR("cfg_led_info"), (config.config & CONFIG_LED_TINFO) ? 1 : 0);
+    js.append(CFG_LED_TINFO, (config.options & OPTION_LED_TINFO) ? 1 : 0);
 
     js.append(CFG_FORM_EMON_HOST, config.emoncms.host);
     js.append(CFG_FORM_EMON_PORT, config.emoncms.port);
@@ -290,16 +290,16 @@ void config_get_json(String &r)
     js.append(CFG_FORM_JDOM_ADCO, config.jeedom.adco);
     js.append(CFG_FORM_JDOM_FREQ, config.jeedom.freq);
 
-    js.append(CFG_FORM_HTTPREQ_HOST, config.httpReq.host);
-    js.append(CFG_FORM_HTTPREQ_PORT, config.httpReq.port);
-    js.append(CFG_FORM_HTTPREQ_URL, config.httpReq.url);
-    js.append(CFG_FORM_HTTPREQ_FREQ, config.httpReq.freq);
+    js.append(CFG_FORM_HTTPREQ_HOST, config.httpreq.host);
+    js.append(CFG_FORM_HTTPREQ_PORT, config.httpreq.port);
+    js.append(CFG_FORM_HTTPREQ_URL, config.httpreq.url);
+    js.append(CFG_FORM_HTTPREQ_FREQ, config.httpreq.freq);
 
-    js.append(CFG_FORM_HTTPREQ_TRIGGER_PTEC, config.httpReq.trigger_ptec);
-    js.append(CFG_FORM_HTTPREQ_TRIGGER_ADPS, config.httpReq.trigger_adps);
-    js.append(CFG_FORM_HTTPREQ_TRIGGER_SEUILS, config.httpReq.trigger_seuils);
-    js.append(CFG_FORM_HTTPREQ_SEUIL_BAS, config.httpReq.seuil_bas);
-    js.append(CFG_FORM_HTTPREQ_SEUIL_HAUT, config.httpReq.seuil_haut, true);
+    js.append(CFG_FORM_HTTPREQ_TRIGGER_PTEC, config.httpreq.trigger_ptec);
+    js.append(CFG_FORM_HTTPREQ_TRIGGER_ADPS, config.httpreq.trigger_adps);
+    js.append(CFG_FORM_HTTPREQ_TRIGGER_SEUILS, config.httpreq.trigger_seuils);
+    js.append(CFG_FORM_HTTPREQ_SEUIL_BAS, config.httpreq.seuil_bas);
+    js.append(CFG_FORM_HTTPREQ_SEUIL_HAUT, config.httpreq.seuil_haut, true);
 }
 
 static int validate_int(const String &value, int a, int b, int d)
@@ -325,45 +325,45 @@ void config_handle_form(ESP8266WebServer &server)
         Serial.println(F("===== Posted configuration"));
 #endif
 
-        // WifInfo
+        // Wi-Fi et avancé
         strncpy(config.ssid, server.arg(CFG_FORM_SSID).c_str(), CFG_SSID_LENGTH);
-        strncpy(config.psk, server.arg("psk").c_str(), CFG_SSID_LENGTH);
-        strncpy(config.host, server.arg("host").c_str(), CFG_HOSTNAME_LENGTH);
-        strncpy(config.ap_psk, server.arg("ap_psk").c_str(), CFG_SSID_LENGTH);
-        strncpy(config.ota_auth, server.arg("ota_auth").c_str(), CFG_SSID_LENGTH);
-        config.ota_port = validate_int(server.arg("ota_port"), 0, 65535, DEFAULT_OTA_PORT);
+        strncpy(config.psk, server.arg(CFG_FORM_PSK).c_str(), CFG_SSID_LENGTH);
+        strncpy(config.host, server.arg(CFG_FORM_HOST).c_str(), CFG_HOSTNAME_LENGTH);
+        strncpy(config.ap_psk, server.arg(CFG_FORM_AP_PSK).c_str(), CFG_SSID_LENGTH);
+        strncpy(config.ota_auth, server.arg(CFG_FORM_OTA_AUTH).c_str(), CFG_SSID_LENGTH);
+        config.ota_port = validate_int(server.arg(CFG_FORM_OTA_PORT), 0, 65535, DEFAULT_OTA_PORT);
 
-        config.config = 0;
-        if (server.hasArg("cfg_led_tinfo"))
-            config.config |= CONFIG_LED_TINFO;
+        config.options = 0;
+        if (server.hasArg(CFG_LED_TINFO))
+            config.options |= OPTION_LED_TINFO;
 
         // Emoncms
-        strncpy(config.emoncms.host, server.arg("emon_host").c_str(), CFG_EMON_HOST_LENGTH);
-        strncpy(config.emoncms.url, server.arg("emon_url").c_str(), CFG_EMON_URL_LENGTH);
-        strncpy(config.emoncms.apikey, server.arg("emon_apikey").c_str(), CFG_EMON_APIKEY_LENGTH);
-        config.emoncms.node = validate_int(server.arg("emon_node"), 0, 255, 0);
-        config.emoncms.port = validate_int(server.arg("emon_port"), 0, 65535, CFG_EMON_DEFAULT_PORT);
-        config.emoncms.freq = validate_int(server.arg("emon_freq"), 0, 86400, 0);
+        strncpy(config.emoncms.host, server.arg(CFG_FORM_EMON_HOST).c_str(), CFG_EMON_HOST_LENGTH);
+        config.emoncms.port = validate_int(server.arg(CFG_FORM_EMON_PORT), 0, 65535, CFG_EMON_DEFAULT_PORT);
+        strncpy(config.emoncms.url, server.arg(CFG_FORM_EMON_URL).c_str(), CFG_EMON_URL_LENGTH);
+        strncpy(config.emoncms.apikey, server.arg(CFG_FORM_EMON_KEY).c_str(), CFG_EMON_KEY_LENGTH);
+        config.emoncms.node = validate_int(server.arg(CFG_FORM_EMON_NODE), 0, 255, 0);
+        config.emoncms.freq = validate_int(server.arg(CFG_FORM_EMON_FREQ), 0, 86400, 0);
 
         // jeedom
         strncpy(config.jeedom.host, server.arg(CFG_FORM_JDOM_HOST).c_str(), CFG_JDOM_HOST_LENGTH);
+        config.jeedom.port = validate_int(server.arg(CFG_FORM_JDOM_PORT), 0, 65535, CFG_JDOM_DEFAULT_PORT);
         strncpy(config.jeedom.url, server.arg(CFG_FORM_JDOM_URL).c_str(), CFG_JDOM_URL_LENGTH);
-        strncpy(config.jeedom.apikey, server.arg(CFG_FORM_JDOM_KEY).c_str(), CFG_JDOM_APIKEY_LENGTH);
+        strncpy(config.jeedom.apikey, server.arg(CFG_FORM_JDOM_KEY).c_str(), CFG_JDOM_KEY_LENGTH);
         strncpy(config.jeedom.adco, server.arg(CFG_FORM_JDOM_ADCO).c_str(), CFG_JDOM_ADCO_LENGTH);
-        config.jeedom.port = validate_int(server.arg(CFG_FORM_JDOM_PORT), 0, 65535, CFG_JDOM_DEFAULT_PORT);
         config.jeedom.freq = validate_int(server.arg(CFG_FORM_JDOM_FREQ), 0, 86400, 0);
 
         // HTTP Request
-        strncpy(config.httpReq.host, server.arg(CFG_FORM_HTTPREQ_HOST).c_str(), CFG_HTTPREQ_HOST_LENGTH);
-        strncpy(config.httpReq.url, server.arg(CFG_FORM_HTTPREQ_URL).c_str(), CFG_HTTPREQ_URL_LENGTH);
-        config.httpReq.port = validate_int(server.arg(CFG_FORM_HTTPREQ_PORT), 0, 65535, CFG_HTTPREQ_DEFAULT_PORT);
-        config.httpReq.freq = validate_int(server.arg(CFG_FORM_HTTPREQ_FREQ), 0, 86400, 0);
-
-        config.httpReq.trigger_ptec = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_PTEC);
-        config.httpReq.trigger_adps = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_ADPS);
-        config.httpReq.trigger_seuils = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_SEUILS);
-        config.httpReq.seuil_bas = validate_int(server.arg(CFG_FORM_HTTPREQ_SEUIL_BAS), 0, 20000, 0);
-        config.httpReq.seuil_haut = validate_int(server.arg(CFG_FORM_HTTPREQ_SEUIL_HAUT), 0, 20000, 0);
+        strncpy(config.httpreq.host, server.arg(CFG_FORM_HTTPREQ_HOST).c_str(), CFG_HTTPREQ_HOST_LENGTH);
+        config.httpreq.port = validate_int(server.arg(CFG_FORM_HTTPREQ_PORT), 0, 65535, CFG_HTTPREQ_DEFAULT_PORT);
+        strncpy(config.httpreq.url, server.arg(CFG_FORM_HTTPREQ_URL).c_str(), CFG_HTTPREQ_URL_LENGTH);
+        config.httpreq.freq = validate_int(server.arg(CFG_FORM_HTTPREQ_FREQ), 0, 86400, 0);
+
+        config.httpreq.trigger_adps = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_ADPS);
+        config.httpreq.trigger_ptec = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_PTEC);
+        config.httpreq.trigger_seuils = server.hasArg(CFG_FORM_HTTPREQ_TRIGGER_SEUILS);
+        config.httpreq.seuil_bas = validate_int(server.arg(CFG_FORM_HTTPREQ_SEUIL_BAS), 0, 20000, 0);
+        config.httpreq.seuil_haut = validate_int(server.arg(CFG_FORM_HTTPREQ_SEUIL_HAUT), 0, 20000, 0);
 
         if (config_save())
         {