Rename --debug option in --display option to avoid misunderstandings

mdeweerd · Jan 9, 2024 · 2ecf4de · 2ecf4de
1 parent 4eb9df9
commit 2ecf4de
Show file tree

Hide file tree

Showing 10 changed files with 135 additions and 107 deletions.
diff --git a/METERSTOHA.BAT b/METERSTOHA.BAT
@@ -20,7 +20,7 @@ REM GOTO TRACE
 
 :INTERACTIF
 REM Interactif:
-python apps/meters_to_ha/meters_to_ha.py -c ./winconfig.json --grdf -r --keep-output --debug --screenshot --chrome-version %CHROME_VERSION%
+python apps/meters_to_ha/meters_to_ha.py -c ./winconfig.json --grdf -r --keep-output --display --screenshot --chrome-version %CHROME_VERSION%
 GOTO END
 
 :NONINTERACTIF
@@ -33,7 +33,7 @@ GOTO END:
 REM Avec trace détaillée
 for /f %%i in ('python -c "import sys ; print(';'.join(sys.path)[1:])"') do SET PY_PATH=%%i
 python -m trace "--ignore-dir=%PY_PATH%" -t ^
-apps/meters_to_ha/meters_to_ha.py -c ./winconfig.json --debug --grdf -r --keep-output --screenshot --chrome-version %CHROME_VERSION% 
+apps/meters_to_ha/meters_to_ha.py -c ./winconfig.json --display --grdf -r --keep-output --screenshot --chrome-version %CHROME_VERSION% 
 
 :END
 
diff --git a/README.md b/README.md
@@ -230,7 +230,7 @@ Explication des champs:
 - Paramètre pour résolution de captcha.\
   Seulement si vous souhaitez
   résoudre les captchas automatiquement (GRDF, sinon vous devez utiliser
-  --debug qui nécessite un serveur X).\
+  --display qui nécessite un serveur X).\
   Un débat assez complet concernant
   ce type de service est dans
   [cet issue d'un autre projet](https://github.com/iv-org/invidious/issues/1256).
@@ -314,7 +314,7 @@ complémentaire MetersToHA sous HAOS.
 | --version-check                               | Vérifie s'il y a une nouvelle version du script (inactif)                                                                                              |
 | --veolia                                      | Récupère les données de Veolia IDF                                                                                                                     |
 | --grdf                                        | Récupère les données auprès de GRDF                                                                                                                    |
-| -d, --debug                                   | Active l'interface graphique interactif (Serveur X nécessaire)                                                                                         |
+| --display                                     | Active l'interface graphique interactif (Serveur X nécessaire)                                                                                         |
 | --screenshot                                  | Prend une ou plusieurs captures d'écran du navigateur (pour débogue)                                                                                   |
 | --local-config                                | Utilise un répertoire local pour la configuration navigateur                                                                                           |
 | -l `LOGS_FOLDER`, --logs-folder `LOGS_FOLDER` | Dossier pour les fichiers des traces                                                                                                                   |
@@ -562,21 +562,21 @@ veolia_idf:
   # script: /config/meters_to_ha/meters_to_ha.py
   # optionnel (Par défaut: false) - add --keep-output option
   keep_output: true
-  # optionnel (Par défaut: false) - add --debug option - nécessite DISPLAY & serveur X!!
-  debug: true
+  # optionnel (Par défaut: false) - add --display option - nécessite DISPLAY & serveur X!!
+  display: false
   # optionnel (Par défaut: false) - Enable line by line trace output (also add outfile/errfile options to send the output to a file)
   trace: true
-  # optionnel (Par défaut: None) - Set DISPLAY for GUI interface (when debug is true)
+  # optionnel (Par défaut: None) - Set DISPLAY for GUI interface (when display is true)
   DISPLAY: 192.1.0.52:0
   # optionnel (Par défaut: None) - Fichier pour la sortie STDOUT du script
   outfile: /config/MetersToHA/meters_to_ha_script.log
   # optionnel (Par défaut: None) - Fichier pour la sortie STDERR du script
   errfile: /config/MetersToHA/apps/meters_to_ha_err.log
 ```
 
-L'option `debug` peut être intéressant lors de la mise en place en cas de
-diffucultés mais nécessite un serveur X, la bonne configuration de DISPLAY
-et l'autorisation d'accès depuis la machine.\
+L'option `--display` peut être intéressant lors de la mise en place en cas
+de diffucultés mais nécessite un serveur X, la bonne configuration de
+DISPLAY et l'autorisation d'accès depuis la machine.\
 Par exemple avec
 
 - [Mobaxterm Portable](https://mobaxterm.mobatek.net/download-home-edition.html).\
@@ -672,9 +672,9 @@ grdf:
   # script: /config/meters_to_ha/meters_to_ha.py
   # optionnel (Par défaut: false) - add --keep-output option
   keep_output: true
-  # optionnel (Par défaut: false) - add --debug option - nécessite DISPLAY & serveur X!!
-  debug: true
-  # optionnel (Par défaut: None) - Set DISPLAY for GUI interface (when debug is true)
+  # optionnel (Par défaut: false) - add --display option - nécessite DISPLAY & serveur X!!
+  display: false
+  # optionnel (Par défaut: None) - Set DISPLAY for GUI interface (when display is true)
   DISPLAY: 192.1.0.52:0
   # optionnel (Par défaut: None) - Fichier pour la sortie STDOUT du script
   outfile: /config/appdaemon/apps/meters_to_ha_script.log
@@ -874,11 +874,11 @@ docker compose run --rm meters-to-ha-veolia
 docker compose run --rm meters-to-ha-grdf
 ```
 
-Ou en mode débogue (nécessite un serveur X local):
+Ou en mode avec affichage (nécessite un serveur X local):
 
 ```shell
-docker compose run --rm meters-to-ha-debug-veolia
-docker compose run --rm meters-to-ha-debug-grdf
+docker compose run --rm meters-to-ha-display-veolia
+docker compose run --rm meters-to-ha-display-grdf
 ```
 
 Docker a parfois
@@ -888,7 +888,7 @@ docker. Dans ce cas, vous pouvez fournir la configuration DISPLAY avec l'IP
 de votre PC directement avec `-eDISPLAY=`:
 
 ```shell
-docker compose run -eDISPLAY=10.33.2.69:0.0 --rm meters-to-ha-debug-grdf
+docker compose run -eDISPLAY=10.33.2.69:0.0 --rm meters-to-ha-display-grdf
 ```
 
 L'automatisation de l'exécution avec Docker dépendre de votre système - le
@@ -1000,14 +1000,14 @@ Un exemple d'un fichier de configuration est:
 }
 ```
 
-Sans l'option `--debug` le déroulement sera visible. Dans ce cas s'il y a
+Sans l'option `--display` le déroulement sera visible. Dans ce cas s'il y a
 un captcha à résoudre, le login ne sera pas réussi. L'option `--screenshot`
 permet d'enregister le ontenu du navigateur (caché) dans
 `screen_before_connection.png` ou vous pouvez vérifier s'il y avait un
 captcha ou pas.
 
 Sinon, pour la résolution du captcha sous Windows en mode interactif,
-l'option `--debug` est nécessaire. Lorsque le popup apparaiti, vous\
+l'option `--display` est nécessaire. Lorsque le popup apparait, vous\
 devez
 le captcha et le valider. Cliquez le bouton "Connexion" également. Si le
 captcha est validé automatiquement, le script avance automatiquement comme
@@ -1017,7 +1017,7 @@ Exemple de lancement, avec un fichier de configuration appelée
 `winconfig.json`, avec une capture d'écran avant connexion.
 
 ```shell
-python apps/meters_to_ha/meters_to_ha.py -c winconfig.json --grdf -r --debug --screenshot
+python apps/meters_to_ha/meters_to_ha.py -c winconfig.json --grdf -r --display --screenshot
 ```
 
 Le fichier [METERSTOHA.BAT](METERSTOHA.BAT) montre plus de variantes sur le
@@ -1157,7 +1157,7 @@ Déroulement de l'exécution :
 4. Téléversement des données dans Domoticz
 
 ```shell
-./apps/meters_to_ha/meters_to_ha.py --run --keep-output --debug
+./apps/meters_to_ha/meters_to_ha.py --run --keep-output --display
 ```
 
 Afficher toutes les options disponibles :
@@ -1183,7 +1183,7 @@ Si vous rencontrez des problèmes à l'exécution, regardez dans un premier
 temps le fichier "veolia.log".
 
 Si cela ne suffit pas, pour aller plus loin il sera utile d'utiliser le
-mode débogue (option `--debug`).
+mode débogue (option `--display`).
 
 Dans ce dernier cas il y a 3 scenarios :
 
@@ -1198,7 +1198,7 @@ Dans ce dernier cas il y a 3 scenarios :
    [Docker](https://www.docker.com/) un serveur X (p.e.
    [VcXsvr](https://sourceforge.net/projects/vcxsrv/)) et le lancer (!)
    avec l'option "Disable Access Control", puis lancer l'un des scripts
-   `docker\*Run.BAT` après avoir ajouté l'option '--debug' à la ligne de
+   `docker\*Run.BAT` après avoir ajouté l'option '--display' à la ligne de
    lancement du script.
 
 Si vous voyez bien une fenêtre X s'afficher à l'écran c'est que
@@ -1228,7 +1228,7 @@ Le système Graphique (GUI) existe, mais l'affichage n'existe que dans une
 zone mémoire.
 
 Il est néanmoins possible de voir le déroulement en temps réel avec
-l'option `--debug`. L'affichage n'est alors plus "Headless" et il vous
+l'option `--display`. L'affichage n'est alors plus "Headless" et il vous
 faudra un serveur X attaché à un écran physique.
 
 ## Environnements testés:

diff --git a/addon_meterstoha/DOCS.md b/addon_meterstoha/DOCS.md
@@ -29,7 +29,7 @@ obtenir les informations de véolia.
 | veolia_password      | Mot de passe pour le site Veolia                                                                                                                                                                                                                                                                                  |
 | skip_download        | Ne télécharge pas les données, mais utilisera les données déjà présentes localement.  Utile lors de la mise au point de la configuration, pendant le débogue, ou lorsque vous téléchargez le fichier par d'autre moyens (car les données sont quand même interprétées et envoyées vers votre système Domotique).  |
 | log_level            | Impacte les messages remonté.  Le niveau "trace" entraine la présence de chaque ligne exécutée dans 'service.log'                                                                                                                                                                                                 |
-| debug                | Ouvrira le navigateur sur le terminal X spécifié dans DISPLAY                                                                                                                                                                                                                                                     |
+| display              | Ouvrira le navigateur sur le terminal X spécifié dans DISPLAY                                                                                                                                                                                                                                                     |
 | DISPLAY              | Spécification complète de l'adresse du terminal X accessible depuis votre instance Home Assistance.  Par exemple, vous lancez MobaXterm sur votre PC qui a comme IP 10.33.2.69, et les connexions depuis votre réseau privé vers ce serveur sont autorisés.  La valeur "10.33.2.69:0.0" est en principe la bonne. |
 | insecure             | Accepte les certificats autosignés.  Utile seulement lorsque ce n'est pas le serveur Home Assistant du module complémentaire ("add-on") est utilisé.                                                                                                                                                              |
 | local_config         | Lorsque actif, maintient les données de configuration de chrome entre les lancements.                                                                                                                                                                                                                             |

diff --git a/addon_meterstoha/config.yaml b/addon_meterstoha/config.yaml
@@ -30,7 +30,7 @@ options:
   veolia_event: call_veolia
   keep_output: true
   screenshot: true
-  debug: false
+  display: false
   skip_download: false
 schema:
   log_level: list(error|warning|info|debug|trace)?
@@ -56,7 +56,7 @@ schema:
   local_config: bool?
   insecure: bool?
   skip_download: bool?
-  debug: bool?
+  display: bool?
   # item: match(regex)
   mqtt_login: str?
   mqtt_password: password?

diff --git a/addon_meterstoha/run.sh b/addon_meterstoha/run.sh
@@ -150,8 +150,8 @@ if bashio::config.has_value type ; then
   TYPE="${TYPE//\"/\\\"}"
 fi
 
-if bashio::config.true debug ; then
-  RUN_OPT="${RUN_OPT} --debug"
+if bashio::config.true display ; then
+  RUN_OPT="${RUN_OPT} --display"
 fi
 
 if bashio::config.true local_config ; then

diff --git a/addon_meterstoha/translations/fr.yaml b/addon_meterstoha/translations/fr.yaml
@@ -78,7 +78,7 @@ configuration:
     description:
       Impacte les messages remonté.  Le niveau "trace" entraine la présence
       de chaque ligne exécutée dans 'service.log'
-  debug:
+  display:
     name: Activation Débogue sur Terminal X
     description: Ouvrira le navigateur sur le terminal X spécifié dans DISPLAY
   DISPLAY: