Merge pull request #425 from maxyvon/update_README

Update readme to add direct link to your home assistant
dvd-dev · Apr 27, 2024 · 3d77aee · 3d77aee
2 parents cbebfc1 + f80c864
commit 3d77aee
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 24 deletions.
diff --git a/README.en.md b/README.en.md
@@ -69,27 +69,31 @@ rewrite it. Hilo is now pushing device readings via websocket from SignalR.
 ### Step 0: Compatible install
 This custom component requires that Hilo has carried out the install in your home. It will not be possible to set it up otherwise.
 
-This custom component has been tested to work by various users on HA OS (as bare metal or VM), Docker with the official (ghcr.io) image and Podman. Other types of install may cause permissions issues during creation of a few files by the custom component.
+This custom component has been tested to work by various users on HA OS (as bare metal or VM), Docker with the official (ghcr.io) image and Podman. Other types of install may cause permission issues during the creation of a few files by the custom component.
 
 ### Step 1: Download files
 
 #### Option 1: Via HACS
 
+[![Open Hilo inside your Home Assistant Community Store (HACS).](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dvd-dev&repository=hilo&category=integration)
+
 Make sure you have [HACS](https://hacs.xyz/docs/setup/download/) installed.
-Under HACS, click the '+ EXPLORE & DOWNLOAD REPOSITORIES' button on the bottom of the page, serch for "Hilo", choose it, and click _download_ in HACS.
+Under HACS, click the '+ EXPLORE & DOWNLOAD REPOSITORIES' button on the bottom of the page, search for "Hilo", choose it, and click _download_ in HACS.
 
 #### Option 2: Manual
 
 Download and copy the `custom_components/hilo` directory from the [latest release](https://github.com/dvd-dev/hilo/releases/latest) to your `custom_components` directory in HA.
 
 ### Step 2: Add integration to HA (<--- this is a step that a lot of people forget)
 
+[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=hilo)
+
 In HA, go to Settings > Devices & Services > Integrations.
 In the bottom right corner, click the '+ ADD INTEGRATION' button.
 
 ![Add Integration](https://github.com/dvd-dev/hilo/assets/108159253/7906f2c9-9547-4478-a625-feaa68e62c5f)
 
-If the component is properly installed, you should be able to find the 'Hilo integration' in the list. You might need to clear you browser cache for the integration to show up.
+If the component is properly installed, you should be able to find the 'Hilo integration' in the list. You might need to clear your browser cache for the integration to show up.
 
 ![Search Integration](https://github.com/dvd-dev/hilo/assets/108159253/1b560a73-042b-46cf-963c-98e5326e98e8)
 
@@ -109,7 +113,7 @@ You must then accept to link your account. To do so, you must enter your Home As
 
 ![Link URL](https://github.com/dvd-dev/hilo/assets/108159253/2c54df64-2e1c-423c-89cf-0eee8f0d4b7b)
 
-After this, you will be prompted with assigning a room for each one of your devices.
+After this, you will be prompted to assign a room for each one of your devices.
 
 ## Configuration (update from a version earlier than v2024.3.1)
 
@@ -119,7 +123,7 @@ After update, you will get an error saying you must reauthenticate for the integ
 
 ![Reath](https://github.com/dvd-dev/hilo/assets/108159253/70118e68-90b9-4667-b056-38ee2cd33133)
 
-After correctly linking your account like in the previous section, you should see a popup telling you the reauthentification was sucessful.
+After correctly linking your account like in the previous section, you should see a popup telling you the reauthentification was successful.
 
 ### Energy meters
 
@@ -149,7 +153,7 @@ home assistant. You simply need to add a line like this in your `configuration.y
     utility_meter:
     ```
 
-* Click `Configure` in the integration UI and check the `Generate energy meters` box.
+* Click`Configure` on the integration UI and check the `Generate energy meters` box.
 
 * Restart home assistant and wait 5 minutes until you see the `sensor.hilo_energy_total_low` entity getting created and populated
   with data:
@@ -170,7 +174,7 @@ home assistant. You simply need to add a line like this in your `configuration.y
 Once created, energy meters will then have to be added manually to the energy dashboard.
 
 
-### Other configuration
+### Other configurations
 
 Other options are available under the `Configure` button in Home Assistant:
 
@@ -305,7 +309,7 @@ EOF
 $ docker restart hass
 ```
 
-### Before submiting a Pull Request
+### Before submitting a Pull Request
 
 It goes without saying you must test your modifications on your local install for problems. You may modify the .py files inside the following folder. Don't forget a backup!
 ```
@@ -329,7 +333,7 @@ And restart Home Assistant
 
 - First you need to `fork` the repository into your own userspace.
 - And then, you can `clone` it on your computer.
-- To maintain some kind of tidyness and standard in the code, we have some linters and validators that need to be executed via `pre-commit` hooks:
+- To maintain some kind of tidiness and standard in the code, we have some linters and validators that need to be executed via `pre-commit` hooks:
 ```
 pre-commit install --install-hooks
 ```
@@ -342,7 +346,7 @@ git add path/to/file
 ```
 git commit -m "I changed this because blabla"
 ```
-- Finally, you can `push` the change on your upstream repository:
+- Finally, you can `push` the change in your upstream repository:
 ```
 git push
 ```

diff --git a/README.md b/README.md
@@ -67,7 +67,9 @@ Cette intégration a été testée par des utilisateurs sous HA OS (bare metal e
 
 #### Option 1: Via HACS
 
-Assurez-vous d'avoir [HACS](https://hacs.xyz/docs/setup/download/) installé.
+[![Ouvrir Hilo dans Home Assistant Community Store (HACS).](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dvd-dev&repository=hilo&category=integration)
+
+Assurez-vous d'avoir [HACS](https://hacs.xyz/docs/setup/download/) d'installé.
 Sous HACS, cliquer le bouton '+ EXPLORE & DOWNLOAD REPOSITORIES' au bas de la page, rechercher "Hilo", le choisir, et cliquer sur _download_ dans HACS.
 
 #### Option 2: Manuellement
@@ -76,6 +78,8 @@ Télécharger et copier le dossier `custom_components/hilo` de la [dernière ver
 
 ### Étape 2: Ajouter l'intégration à HA (<--- étape souvent oubliée)
 
+[![Ouvrir Home Assistant et démarrer la configuration d'une nouvelle intégration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=hilo)
+
 Dans HA, aller à Paramètres > Appareils et services > Intégrations.
 Dans le coin inférieur droit, cliquer sur le bouton '+ AJOUTER UNE INTÉGRATION'.
 
@@ -93,7 +97,7 @@ La configuration est faite via l'interface utilisateur. Lorsque vous ajoutez l'i
 
 ![Auth Hilo](https://github.com/dvd-dev/hilo/assets/108159253/e4e98b32-78d0-4c49-a2d7-3bd0ae95e9e0)
 
-Vous devez ensuite accepter de lier votre compte. Pour ce faire, saisir l'addresse (URL ou IP) de votre instance Home Assistant et appuyez sur Link Account.
+Vous devez ensuite accepter de lier votre compte. Pour ce faire, saisir l'adresse (URL ou IP) de votre instance Home Assistant et appuyer sur Link Account.
 
 ![Link](https://github.com/dvd-dev/hilo/assets/108159253/5eb945f7-fa5e-458f-b0fe-ef252aaadf93)
 
@@ -107,13 +111,13 @@ Après la mise à jour, vous obtiendrez une erreur comme quoi vous devez vous r
 
 ![Réauthentifier](https://github.com/dvd-dev/hilo/assets/108159253/6b1bf2c3-0d7a-4eb8-815b-594401fc09ef)
 
-Après avoir lié votre compte comme montré à la section configuration initale, le message suivant apparaîtra.
+Après avoir lié votre compte comme montré à la section configuration initiale, le message suivant apparaitra.
 
 ![Réauthentifié succès](https://github.com/dvd-dev/hilo/assets/108159253/7708b449-24c3-43c1-843b-8697ae192db1)
 
 ### :warning: Compteurs de consommation électrique
 
-La génération automatique des compteurs de consommation électrique est actuellement brisée. J'avais codé ça quand le panneau d'énergie de Homeassistant venait d'être rendu disponible et malheureusement, cette partie du code a changé énormément. Je n'ai plus le temps pour le moment de me remettre la tête là-dedans mais si quelqu'un est assez brave pour se pencher là-dessus en détail, ça va me faire plaisir de merger les patchs.
+La génération automatique des compteurs de consommation électrique est actuellement brisée. J'avais codé ça quand le panneau d'énergie de Homeassistant venait d'être rendu disponible et malheureusement, cette partie du code a changé énormément. Je n'ai plus le temps pour le moment de me remettre la tête là-dedans, mais si quelqu'un est assez brave pour se pencher là-dessus en détail, ça va me faire plaisir de merger les patchs.
 
 Voir les issues #204 #281 #292
 
@@ -127,11 +131,11 @@ D'autres options sont disponibles sous le bouton "Configurer" dans Home Assistan
 
 - `Générer seulement les compteurs totaux pour chaque appareil`: Case à cocher
 
-  Calculez uniquement le total d'énergie sans diviser entre le coût faible et le coût élevé
+  Calculez uniquement le total d'énergie sans diviser entre le cout faible et le cout élevé
 
 - `Enregistrer également les données de demande et les messages Websocket (nécessite un niveau de journal de débogage à la fois sur l'intégration et sur pyhilo)`: Case à cocher
 
-  Permet un niveau de journalisation plus élevé pour les développeurs/le débogage
+  Permets un niveau de journalisation plus élevé pour les développeurs/le débogage
 
 - `Vérouiller les entités climate lors de défis Hilo, empêchant tout changement lorsqu'un défi est en cours.`: Case à cocher
 
@@ -141,7 +145,7 @@ D'autres options sont disponibles sous le bouton "Configurer" dans Home Assistan
 
   Toutes les sources d'énergie autres que le matériel Hilo sont regroupées dans un seul capteur. Utilise la lecture du compteur intelligent de la maison.
 
-- `Nom du tarif Hydro Québec ('rate d' ou 'flex d')`: chaîne
+- `Nom du tarif Hydro Québec ('rate d' ou 'flex d')`: chaine
 
   Définissez le nom du plan tarifaire d'Hydro-Québec.
   Seules 2 valeurs sont prises en charge pour le moment:
@@ -150,7 +154,7 @@ D'autres options sont disponibles sous le bouton "Configurer" dans Home Assistan
 
 - `Intervalle de mise à jour (min: 60s)`: Nombre entier
 
-  Nombre de secondes entre chaque mise à jour de l'appareil. Par défaut à 60s. Il n'est pas recommandé d'aller en dessous de 30, car cela pourrait entraîner une suspension de Hilo. Depuis [2023.11.1](https://github.com/dvd-dev/hilo/releases/tag/v2023.11.1) le minimum est passé de 15s à 60s.
+  Nombre de secondes entre chaque mise à jour de l'appareil. Par défaut à 60s. Il n'est pas recommandé d'aller en dessous de 30, car cela pourrait entrainer une suspension de Hilo. Depuis [2023.11.1](https://github.com/dvd-dev/hilo/releases/tag/v2023.11.1) le minimum est passé de 15s à 60s.
 
 ## Exemples d'intégrations Lovelace et d'automatisations
 
@@ -175,7 +179,7 @@ Vous pouvez trouver la FAQ dans le wiki du projet: https://github.com/dvd-dev/hi
 
 Rapporter tout problème est une bonne manière disponible à tous de contribuer au projet.
 
-Si vous éprouvez des problèmes ou voyez des comportements étranges, merci de soumettre un "Issue" et d'y attach vos journaux.
+Si vous éprouvez des problèmes ou voyez des comportements étranges, merci de soumettre une "Issue" et d'y attacher vos journaux.
 
 Pour mettre en fonction la journalisation de débogage, vous devez ajouter ceci dans votre fichier `configuration.yaml`:
 ```yaml
@@ -186,11 +190,11 @@ logger:
      pyhilo: debug
 ```
 
-Si vous avez de l'expérience python ou Home Assistant et que vous souhaitez contribuer au code, n'hésitez pas à soumettre une pull request.
+Si vous avez de l'expérience python ou Home Assistant et que vous souhaitez contribuer au code, n'hésitez pas à soumettre un pull request.
 
-### Préparer un environment de développement sur MacOS / Linux
+### Préparer un environnement de développement sur macOS / Linux
 
-1. Preparer les dossiers necessaires:
+1. Préparer les dossiers nécessaires:
 ```console
 $ HASS_DEV=~/hass-dev/
 $ HASS_RELEASE=2023.12.3
@@ -216,15 +220,15 @@ $ docker run -d -p 8123:8123 \
   homeassistant/home-assistant:$HASS_RELEASE
 ```
 
-3. Verifier que le container roule
+3. Vérifier que le container roule
 
 ```console
 $ docker ps
 CONTAINER ID   IMAGE                                    COMMAND   CREATED       STATUS          PORTS                    NAMES
 bace2264ee54   homeassistant/home-assistant:2023.12.3   "/init"   3 hours ago   Up 28 minutes   0.0.0.0:8123->8123/tcp   hass
 ```
 
-4. Verifier les logs de home-assistant
+4. Vérifier les logs de home-assistant
 ```console
 $ less ${HASS_DEV}/config/home-assistant.log
 $ grep hilo ${HASS_DEV}/config/home-assistant.log