Merge pull request #1 from sebcaps/dev

Dev to main

Author: sebcaps

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+{
+	"name": "Tuto dev hacs",
+	"image": "mcr.microsoft.com/devcontainers/python:0-3.11",
+	"appPort": [
+		"9123:8123"
+	],
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-python.python",
+				"github.vscode-pull-request-github",
+				"ryanluker.vscode-coverage-gutters",
+				"ms-python.vscode-pylance"
+			],
+			"settings": {
+				"files.eol": "\n",
+				"editor.tabSize": 4,
+				"terminal.integrated.profiles.linux": {
+					"Bash Profile": {
+						"path": "bash",
+						"args": []
+					}
+				},
+				"terminal.integrated.defaultProfile.linux": "Bash Profile",
+				"python.pythonPath": "/usr/bin/python3",
+				"python.analysis.autoSearchPaths": true,
+				"python.linting.pylintEnabled": true,
+				"python.linting.enabled": true,
+				"python.formatting.provider": "black",
+				"editor.formatOnPaste": false,
+				"editor.formatOnSave": true,
+				"editor.formatOnType": true,
+				"files.trimTrailingWhitespace": true
+			}
+		}
+	},
+	"postCreateCommand": "pip install -r requirements.txt"
+}

.gitignore

@@ -50,7 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
-
+tests/
 # Translations
 *.mo
 *.pot
@@ -158,3 +158,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+config
+requirements.txt

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // Utilisez IntelliSense pour en savoir plus sur les attributs possibles.
+    // Pointez pour afficher la description des attributs existants.
+    // Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Home Assistant",
+            "type": "python",
+            "request": "launch",
+            "module": "homeassistant",
+            "justMyCode": false,
+            "args": [
+                "--debug",
+                "-c",
+                "config"
+            ]
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "editor.formatOnSave": true,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.python"
+    },
+    "python.formatting.provider": "none"
+}

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Run Home Assistant on port 9123",
+            "type": "shell",
+            "command": "ln -s $PWD/custom_components $PWD/config/custom_components ; hass -c ./config",
+            "problemMatcher": []
+        },
+        {
+            "label": "Restart Home Assistant on port 9123",
+            "type": "shell",
+            "command": "pkill hass ; hass -c ./config",
+            "problemMatcher": []
+        }
+    ]
+}

README.md

@@ -1,2 +1,35 @@
-# hydrao
-Home Assistant integration to get Hydrao data
+# Hydrao pour Home Assistant
+Intégration pour remonter les informations de ces pommeaux de douches Hydrao dans Home Assistant.
+
+## Installation
+
+Utilisez [hacs](https://hacs.xyz/).
+[![Ouvrez votre instance Home Assistant et ouvrez un référentiel dans la boutique communautaire Home Assistant.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=sebcaps&repository=hydrao&category=integration)
+
+## Configuration
+
+### Obtenir une clé d'API
+
+- Faire une demande de clé d'API à Hydrao en utilisant leur [formulaire de support](https://www.hydrao.com/fr/besoin-d-aide-/sav).
+
+### Configuration dans Home Assistant
+
+La méthode de configuration consiste à utiliser l'interface utilisateur.
+
+Il faut tout d'abord saisir ces [identifiants d'accés](#obtenir-une-clé-dapi) à l'API.
+
+![image info](img/authent.png)
+
+En cas de d'installation avec plusieurs pommeaux disponible, une sélection du (des) dispositif(s) est possible.
+
+> **Note**
+> Les données sont issues des serveurs Hydrao via leur API. Cette intégration ne se connecte pas aux pommeaux, et ne se substitue pas au téléphone ou la passerelle Hydrao.
+
+### Données
+
+Les données affichées sont  :
+
+- Volume moyen en L
+- Volume total en L
+- Nombre de douche
+- Tendance en %

compose-dev.yaml

@@ -0,0 +1,12 @@
+services:
+  app:
+    entrypoint:
+    - sleep
+    - infinity
+    image: docker/dev-environments-default:stable-1
+    init: true
+    volumes:
+    - type: bind
+      source: /var/run/docker.sock
+      target: /var/run/docker.sock
+

custom_components/hydrao/__init__.py

@@ -0,0 +1,84 @@
+""" Les constantes pour l'intégration Tuto HACS """
+import logging
+from datetime import timedelta, date
+from homeassistant.const import Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.helpers.typing import ConfigType
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+from homeassistant.helpers.update_coordinator import  DataUpdateCoordinator
+from homeassistant.helpers import device_registry as dr, entity_registry as er
+from homeassistant.components.sensor import (SensorEntity)
+from .api import HydraoAPI
+from .const import DOMAIN, PLATFORMS,NAME, REFRESH_INTERVALL, CONF_DEVICES
+
+_LOGGER = logging.getLogger(__name__)
+
+PLATFORM: list[Platform] = [Platform.SENSOR]
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
+    """Initialisation from a config entry."""
+    _LOGGER.info(
+        "Initializing %s integration with plaforms: %s with config: %s",
+        DOMAIN,
+        PLATFORMS,
+        entry,
+    )
+    hass.data.setdefault(DOMAIN, {})
+    api = HydraoAPI(entry.data)
+
+    devices: list[str] = entry.options[CONF_DEVICES]
+
+
+    if entry.entry_id not in hass.data[DOMAIN]:
+        hass.data[DOMAIN][entry.entry_id] = {}
+        hass.data[DOMAIN][entry.entry_id]["hydraoapi"]= api
+        for device in devices:
+            coordinator = HydraoApiCoordinator(hass=hass, config = entry, api=api, uuid=device)
+            # await coordinator.async_config_entry_first_refresh() # is it mandatory?
+            hass.data[DOMAIN][entry.entry_id][device] = coordinator
+
+    await hass.config_entries.async_forward_entry_setups(entry, [Platform.SENSOR])
+
+    _LOGGER.debug("Setup of %s successful", entry.title)
+
+    return True
+
+
+class HydraoApiCoordinator(DataUpdateCoordinator):
+    """A coordinator to fetch data from the api only once"""
+
+    def __init__(self, hass, config: ConfigType, api, uuid):
+        super().__init__(
+            hass,
+            _LOGGER,
+            name=NAME,  # for logging purpose
+            update_method=self._update_method,
+            update_interval=timedelta(minutes=REFRESH_INTERVALL),
+        )
+        self.config = config
+        self.hass = hass
+        self.api = api
+        self.uuid = uuid
+
+
+    async def _update_method(self):
+        data = await self.api.async_get_device_stat(self.uuid)
+        if data is not None and len(data) > 0:
+            return True
+        else:
+            self.async_set_update_error(
+                f'No Data from HYDRAO'
+            )
+            return False
+
+    async def async_unload_entry(self, hass: HomeAssistant, entry: ConfigEntry) -> bool:
+        """This method is called to clean all sensors before re-adding them"""
+        _LOGGER.debug("async_unload_entry method called")
+        unload_ok = await hass.config_entries.async_unload_platforms(
+            entry, [Platform.SENSOR]
+        )
+        if unload_ok:
+            hass.data[DOMAIN].pop(entry.entry_id)
+        return unload_ok

custom_components/hydrao/api.py

@@ -0,0 +1,128 @@
+import logging
+import aiohttp
+from aiohttp.client import ClientTimeout, ClientError
+from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, CONF_API_KEY
+from .const import AUTH_URL, DATA_URL, CLIENT_TIMEOUT,ERROR_MESSAGE_429
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class HydraoAPI:
+    """Api to get Hydrao data"""
+
+    def __init__(
+        self, config, session: aiohttp.ClientSession = None, timeout=CLIENT_TIMEOUT
+    ) -> None:
+        self._timeout = timeout
+        if session is not None:
+            self._session = session
+        else:
+            self._session = aiohttp.ClientSession()
+        self._config = config
+        self._token = None
+        self._data = None
+        self._headers={}
+
+    async def async_get_token(self):
+        """Get user token to allow request"""
+        self._headers={
+                    "x-api-key": self._config[CONF_API_KEY],
+                    "Content-type" : "application/json"
+                }
+        request = await self._session.post(
+            AUTH_URL,
+            headers = self._headers,
+            json={
+                "email": self._config[CONF_EMAIL],
+                "password": self._config[CONF_PASSWORD],
+            },
+        )
+        if request.status == 200:
+            resp = await request.json()
+            self._token = resp["access_token"]
+            _LOGGER.debug("got response %s ", resp)
+        elif request.status ==429: #Too many request
+            _LOGGER.error(
+                ERROR_MESSAGE_429
+            )
+            raise ValueError
+        else:
+            _LOGGER.error(
+               ERROR_MESSAGE_429
+            )
+            raise ValueError
+
+    async def async_get_devices(self):
+        self._headers["Authorization"]=f"Bearer {self._token}"
+        request = await self._session.get(
+            DATA_URL,
+            headers = self._headers,
+        )
+        if request.status == 200:
+            resp = await request.json()
+            _LOGGER.debug("got response %s ", resp)
+            return resp
+        elif request.status ==429: #Too many request
+            _LOGGER.error(
+              ERROR_MESSAGE_429
+            )
+            raise ValueError
+        else:
+            _LOGGER.error(
+                "Failed to get devices list info, with status %s ", request.status
+            )
+            raise ValueError
+
+    async def get_device_details(self, uuid):
+        if not self._token:
+            await self.async_get_token()
+        self._headers["Authorization"]=f"Bearer {self._token}"
+        request = await self._session.get(
+            f"{DATA_URL}/{uuid}",
+            headers = self._headers,
+        )
+        if request.status == 200:
+            resp = await request.json()
+            _LOGGER.debug("got response %s ", resp)
+            return resp
+        elif request.status == 429: #Too many request
+            _LOGGER.error(
+               ERROR_MESSAGE_429
+            )
+            raise ValueError
+        else:
+            _LOGGER.error(
+                "Failed to get device info, with status %s ", request.status
+            )
+            raise ValueError
+
+    async def async_get_device_stat(self, uuid):
+        if not self._token:
+            await self.async_get_token()
+        request = await self._session.get(
+            f"{DATA_URL}/{uuid}/stats",
+            headers = self._headers,
+        )
+        if request.status == 200:
+            resp = await request.json()
+            _LOGGER.debug("got response %s ", resp)
+            self._data= resp
+            return resp
+        elif request.status == 429: #Too many request
+            _LOGGER.error(
+               ERROR_MESSAGE_429
+            )
+            raise ValueError
+        else:
+            _LOGGER.error(
+                "Failed to get devices info, with status %s ", request.status
+            )
+            raise ValueError
+
+    def get_key(self, key):
+        """Get value for the given key in JSON Data"""
+        if self._data is not None:
+            return self._data.get(key)
+        else:
+            return ""