Merge pull request #179 from saniho/dev

Dev

Author: saniho

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 exclude: (?x)^( \.idea/.* |.*cache/.* |.scannerwork/.* |.*properties )$
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.2.0
     hooks:
       - id: no-commit-to-branch
         args: [--branch, main]
@@ -27,21 +27,21 @@ repos:
       - id: yamllint
         args: [--no-warnings, -d, '{extends: relaxed, rules: {line-length: {max: 120}}}']
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.1
+    rev: v2.32.0
     hooks:
       - id: pyupgrade
         args:
           - --py37-plus
   - repo: https://github.com/psf/black
-    rev: 22.1.0
+    rev: 22.3.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
           - -l 88
   - repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
-    rev: v1.0.5
+    rev: v1.0.6
     hooks:
       - id: python-bandit-vulnerability-check
         args: [--skip, 'B101,B105,B110,B307,B310,B311', --recursive, .]
@@ -79,7 +79,7 @@ repos:
   #         - --skip="./.*"
   #         - --quiet-level=2
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.942
+    rev: v0.950
     hooks:
       - id: mypy
         args: [--ignore-missing-imports, --install-types, --non-interactive, --check-untyped-defs,

README.md

@@ -26,62 +26,62 @@ Avant de pouvoir utiliser cette intégration, assurez vous :
 ## Installer l'intégration
 
 <details>
-  <summary><b>Via HACS (mise à jour en un clic) : </b></summary><br>
+  <summary><b>Via HACS (mise à jour en un clic) : </b></summary><br />
 
 - Ouvrez HACS, cliquez sur `Intégration`, puis selectionnez le menu 3
   points en haut à droite.
 
 \*si vous n'avez pas HACS, pour l'installer cela se passe ici :
 [HACS : Ajoutez des modules et des cartes personnalisées](https://forum.hacf.fr/t/hacs-ajoutez-des-modules-et-des-cartes-personnalisees/359)
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_add_repo_01.png" height="300"/>
- <br>
+<img src="./img/HACS_add_repo_01.png" height="300"/>
+ <br />
  </p>
 
 - Ajoutez le dépot personnalisé : `https://github.com/saniho/apiEnedis`
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_add_repo_02.png" width="600"/>
- <br>
+<img src="./img/HACS_add_repo_02.png" width="600"/>
+ <br />
  </p>
 
 - Cliquez sur le bouton `Installer` de la carte correspondant à
   l'intégration
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_install_integration_01.png" width="400"/>
- <br>
+<img src="./img/HACS_install_integration_01.png" width="400"/>
+ <br />
  </p>
 
 - Cliquez sur le bouton `Installer` de la popup
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_install_integration_02.png" width="600"/>
- <br>
+<img src="./img/HACS_install_integration_02.png" width="600"/>
+ <br />
  </p>
 
 - La carte de l'intégration est maintenant rouge, signifiant qu'un
   redémarrage du serveur Home Assistant est nécessaire
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_install_integration_03.png" width="400"/>
- <br>
+<img src="./img/HACS_install_integration_03.png" width="400"/>
+ <br />
  </p>
 
 - Accédez à la vue `Contrôle du serveur` (`Configuration` ->
   `Contrôle du serveur`), puis cliquez sur le bouton `Redémarrer` dans la
   zone `Gestion du serveur`
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_install_integration_04.png" width="400"/>
- <br>
+<img src="./img/HACS_install_integration_04.png" width="400"/>
+ <br />
  </p>
 
 </details>
@@ -108,19 +108,19 @@ Avant de pouvoir utiliser cette intégration, assurez vous :
 - Appuyez sur le bouton bleu `Ajouter l'intégration` en bas à droite de la
   vue
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_add_integration_01.png" height="500"/>
- <br>
+<img src="./img/HACS_add_integration_01.png" height="500"/>
+ <br />
  </p>
 
 - Tapez dans le champ de recherche qui vient d'apparaître : `myenedis` et
   cliquez sur l'intégration
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_add_integration_02.png" height="300"/>
- <br>
+<img src="./img/HACS_add_integration_02.png" height="300"/>
+ <br />
  </p>
 
 - Renseigner :
@@ -137,10 +137,10 @@ Avant de pouvoir utiliser cette intégration, assurez vous :
 
 - Validez la saisie avec le bouton `Soumettre`
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/HACS_add_integration_03.png" width="300"/>
- <br>
+<img src="./img/HACS_add_integration_03.png" width="300"/>
+ <br />
  </p>
 
 - Fermez la popup de confirmation en cliquant sur le bouton `Terminer`
@@ -160,12 +160,16 @@ votre navigateur en faisant la combinaison de touche `CTRL+F5` ou
 
 L'intégration crée l'entité `sensor.myenedis_<<votrecode>>`
 
-<br>
+<br />
  <p align="center">
-<img src="https://raw.githubusercontent.com/saniho/apiEnedis/main/img/sensor_v2.png"/>
- <br>
+<img src="./img/sensor_v2.png"/>
+ <br />
  </p>
 
+## "Ca ne marche pas"
+
+### Forum HACF.FR
+
 ______________________________________________________________________
 
 N'hésitez pas à aller faire un tour sur ce forum ou vous trouverez pleins
@@ -175,6 +179,54 @@ https://forum.hacf.fr/t/hacs-ajoutez-des-modules-et-des-cartes-personnalisees/35
 
 ______________________________________________________________________
 
+
+### Activer le débogue
+
+<details>
+  <summary><b>Via l'interface, temporairement : </b></summary><br />
+
+Avec des traces de débogue il est généralement plus facile d'identifier
+la cause d'un problème de fonctionnement.
+
+Une manière c'est d'activer les messages de débogue dans le fichier
+`config/home-assistant.log` en l'activant depuis l'interface.  Pour cela allez
+directement vers [Outils de Développement > Services](https://my.home-assistant.io/redirect/developer_services/).
+
+Puis, passer en mode `YAML` et copiez-collez le code suivant, puis cliquez
+`APPELER LE SERVICE`:
+
+```yaml
+service: logger.set_level
+data:
+  myEnedis: debug
+
+```
+
+En image:
+
+<p align="center"><img src="./img/ha_debug.png" width="300"/></p>
+
+Le fichier `config/home-assistant.log` se remplit alors de pleins de traces
+de débogue lié à `apiEnedis` connu comme `myEnedis` dans Home Assistant.
+
+
+Ceci continue jusqu'au redémarrage de Home Assistant ou jusqu'à ce que vous
+exécutez de la même manière que pour l'activation:
+
+
+```yaml
+service: logger.set_level
+data:
+  myEnedis: warning
+
+```
+</details>
+
+
+## Historique des versions
+
+Cette partie n'est pas tenu à jour.
+
 <details>
   <summary><b>VERSION</b></summary>
 

custom_components/apiEnedis/apiconst.py

@@ -0,0 +1,25 @@
+# Constants for API Json
+
+# Error code - string
+ERROR_CODE = "error_code"
+# Error string - string
+ERROR = "error"
+
+# Note: both of these fields occur - same meaning:
+# Alert user - bool
+ALERT_USER = "alert_user"
+# User alert - bool
+USER_ALERT = "user_alert"
+
+# tag
+TAG = "tag"
+# description - string
+DESCRIPTION = "description"
+
+# Structure with meter reading data
+METER_READING = "meter_reading"
+
+ENEDIS_RETURN = "enedis_return"
+# Fields in "enedis_return"
+ENEDIS_RETURN_ERROR = "error"
+ENEDIS_RETURN_MESSAGE = "message"

custom_components/apiEnedis/const.py

@@ -63,8 +63,6 @@ def __init__(self):
 PLATFORMS = ["sensor"]
 
 _formatDateYmd = "%Y-%m-%d"
-_formatDateYm01 = "%Y-%m-01"
-_formatDateY0101 = "%Y-01-01"
 
 ENTITY_NAME = "name"
 ENTITY_DELAI = "delai"

custom_components/apiEnedis/myCall.py

@@ -15,6 +15,8 @@
 import re
 import sys
 
+from . import apiconst as API
+
 _LOGGER = logging.getLogger(__nameMyEnedis__)
 
 # Min and Max Delays for initial call and subsequent calls.
@@ -134,13 +136,18 @@ def post_and_get_json(self, url, params=None, data=None, headers=None):
         minDelay: float = INITIAL_CALL_DELAY
         while maxTriesToGo > 0:
             maxTriesToGo -= 1
+            hasError = True  # Suppose error, will be set to False if no exception
             try:
                 if not myCall.isAvailable():
+                    _LOGGER.warning(
+                        "Nombre d'appels à l'API dépassé,"
+                        " ou dernière erreur trop récente"
+                    )
                     dataAnswer = {
-                        "error_code": "UNAVAILABLE",
-                        "enedis_return": {
-                            "error": "UNAVAILABLE",
-                            "message": "Indisponible, essayez plus tard",
+                        API.ERROR_CODE: "UNAVAILABLE",
+                        API.ENEDIS_RETURN: {
+                            API.ENEDIS_RETURN_ERROR: "UNAVAILABLE",
+                            API.ENEDIS_RETURN_MESSAGE: "Indisponible, essayez plus tard",
                         },
                     }
                     self.setLastAnswer(dataAnswer)
@@ -162,15 +169,14 @@ def post_and_get_json(self, url, params=None, data=None, headers=None):
                 logPrefix = f"====== Appel http #{counter} !!! "
                 _LOGGER.info(f"{logPrefix}=====")
 
-                # raise(requests.exceptions.Timeout) # pour raiser un timeout de test ;)
                 response = session.post(
                     url,
                     params=params,
                     data=json.dumps(data),
                     headers=headers,
                     timeout=30,
                 )
-                # Generate test data with next line
+                # Write API result to file (test generation, debug)
                 self.saveApiReturn(counter, response.text)
 
                 response.raise_for_status()
@@ -180,14 +186,15 @@ def post_and_get_json(self, url, params=None, data=None, headers=None):
                 _LOGGER.info(f"{logPrefix}data : {data} =====")
                 _LOGGER.info(f"{logPrefix}reponse : {dataAnswer} =====")
                 maxTriesToGo = 0  # Done
+                hasError = False
             except requests.exceptions.Timeout:
                 myCall.handleTimeout()
                 # a ajouter raison de l'erreur !!!
                 _LOGGER.error(f"{logPrefix}requests.exceptions.Timeout")
                 dataAnswer = {
-                    "enedis_return": {
-                        "error": "UNKERROR_TIMEOUT",
-                        "message": "Timeout",
+                    API.ENEDIS_RETURN: {
+                        API.ENEDIS_RETURN_ERROR: "UNKERROR_TIMEOUT",
+                        API.ENEDIS_RETURN_MESSAGE: "Timeout",
                     }
                 }
                 self.setLastAnswer(dataAnswer)
@@ -202,8 +209,7 @@ def post_and_get_json(self, url, params=None, data=None, headers=None):
                     _LOGGER.error(f"data : {json.dumps(data)} ")
                     _LOGGER.error(f"Error JSON : {response.text} ")
                     _LOGGER.error("*" * 60)
-                # with open('error.json', 'w') as outfile:
-                #    json.dump(response.json(), outfile)
+
                 dataAnswer = response.json()
                 self.setLastAnswer(dataAnswer)
 
@@ -215,12 +221,13 @@ def post_and_get_json(self, url, params=None, data=None, headers=None):
                 ):
                     maxTriesToGo = 0  # Fatal error, do not try again
 
-        _LOGGER.debug("Data answer: %r", dataAnswer)
-        # if ( "enedis_return" in dataAnswer.keys() ):
-        #    if ( type( dataAnswer["enedis_return"] ) is dict ):
-        #        if ( "error" in dataAnswer["enedis_return"].keys()):
-        #            if ( dataAnswer["enedis_return"]["error"] == "UNKERROR_TIMEOUT"):
-        #                raise error
+            # Log result as error in case of exception, or as debug otherwise
+            _LOGGER.log(
+                logging.ERROR if hasError else logging.DEBUG,
+                "Data answer: %r",
+                dataAnswer,
+            )
+
         return dataAnswer
 
     def getDataPeriod(self, deb: str, fin: str | None) -> tuple[str, bool]: