Make name configurable

Setup ESLint
Remove pretty-quick
Improve logs
Bump version

.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+  overrides: [],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['prettier', '@typescript-eslint'],
+  rules: {
+    'prettier/prettier': 'warn',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx pretty-quick --staged
+npx lint-staged --concurrent false

CONTRIBUTING.md

@@ -2,6 +2,7 @@
 
 ## Running locally
 
+- Comment the `image` line in `config.yaml` so the add-on can be rebuilt locally
 - Open in VSCode with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
 - If not in a container already, click on "Reopen in container" when prompted
 - Click Terminal > Run Task > Start Home Assistant

README.md

@@ -14,7 +14,9 @@
 
 Il utilise le module [@bokub/linky](https://github.com/bokub/linky) et le service [Conso API](https://conso.boris.sh/) pour communiquer avec Enedis et récupérer votre consommation.
 
-![Energy](https://github.com/bokub/ha-linky/assets/17952318/36e7be04-953c-4c2c-9cff-f45016893002)
+<p align="center">
+  <img height="452" src="https://github.com/bokub/ha-linky/assets/17952318/ed53a1d5-e0c6-4c50-88ac-576f6542e63b">
+</p>
 
 ## Prérequis
 
@@ -27,29 +29,30 @@ Pour utiliser cet add-on, il vous faut :
 ## Installation
 
 - Cliquez [ici](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fbokub%2Fha-linky) pour ajouter le repository à Home Assistant. Si le lien ne fonctionne pas :
-  - Depuis Home Assistant, ouvrez le menu "_Paramètres_" / "_Settings_", puis "_Modules complémentaires_" / "_Add-ons_"
-  - Cliquez sur le bouton "_Boutique_" / "_Store_" en bas à droite
-  - Cliquer sur les trois points en haut à droite, puis "_Dépôts_" / "_Repositories_"
+  - Depuis Home Assistant, ouvrez le menu _Paramètres_ / _Settings_, puis _Modules complémentaires_ / _Add-ons_
+  - Cliquez sur le bouton _Boutique_ / _Store_ en bas à droite
+  - Cliquer sur les trois points en haut à droite, puis _Dépôts_ / _Repositories_
   - Ajoutez `https://github.com/bokub/ha-linky`
-- Cliquez sur "_Ajouter_" / "_Add_" puis fermez la boite de dialogue
-- Cherchez "_Linky_" dans la liste des add-ons et cliquez dessus (vous pouvez utiliser la barre de recherche)
+- Cliquez sur _Ajouter_ / _Add_ puis fermez la boite de dialogue
+- Cherchez _Linky_ dans la liste des add-ons et cliquez dessus (vous pouvez utiliser la barre de recherche)
 - Installez l'add-on en cliquant sur le bouton dédié
 
 ## Configuration
 
-Une fois l'add-on installé, rendez-vous dans l'onglet "_Configuration_" et remplissez les champs vides :
+Une fois l'add-on installé, rendez-vous dans l'onglet _Configuration_ et remplissez les champs vides :
 
 - `consumption PRM` : Votre numéro de PRM (14 chiffres).
-  - Si vous ne le connaissez pas, entrez votre token sur [la page exemples](https://conso.boris.sh/exemples) de Conso API et le PRM s'affichera dans le champ "_PRM_"
-  - Vous pouvez également le trouver sur votre compteur en appuyant sur la touche **+** jusqu’à lire la valeur du "_numéro de PRM_".
-- `consumption token` : Votre token _Conso API_
-- `consumption action` : Laissez la valeur par défaut, `sync`
+  - Si vous ne le connaissez pas, entrez votre token sur [la page exemples](https://conso.boris.sh/exemples) de Conso API et le PRM s'affichera dans le champ _PRM_
+  - Vous pouvez également le trouver sur votre compteur en appuyant sur la touche **+** jusqu’à lire la valeur du _numéro de PRM_.
+- `consumption token` : Votre token **Conso API**
+- `consumption name` : Choisissez le nom qui sera affiché dans les tableaux de bord d'énergie. Vous pourrez le changer plus tard si vous le souhaitez.
+- `consumption action` : Laissez la valeur par défaut: `sync`
 
 Appliquez les modifications et démarrez / redémarrez l'add-on si ce n'est pas déjà fait
 
 ## Utilisation / fonctionnement
 
-Une fois l'add-on démarré, rendez-vous dans l'onglet "_Journal_" / "_Log_" pour suivre la progression de la synchronisation.
+Une fois l'add-on démarré, rendez-vous dans l'onglet _Journal_ / _Log_ pour suivre la progression de la synchronisation.
 
 Au premier lancement, **HA Linky** essaiera de récupérer toutes les données de consommation depuis la date d'installation de votre compteur Linky.
 
@@ -58,29 +61,29 @@ Ensuite, il synchronisera les données deux fois par jour tant qu'il n'est pas a
 - Une fois entre 6h et 7h du matin pour récupérer les données de la veille
 - Une fois entre 9h et 10h du matin au cas où la première synchronisation a échoué
 
-Vous pourrez vérifier le bon fonctionnement de l'add-on en vous rendant dans l'onglet "_Journal_" / "_Log_", où toutes les informations utiles seront affichées.
-
-### Bon à savoir
-
-- Les données d’une journée ne sont pas accessibles en temps réel, il faut attendre le lendemain de leur mesure pour pouvoir les récupérer, entre 6h et 10h.
-- Pour les dates récentes (moins de 7 jours), **HA Linky** essaiera de récupérer en priorité des données par demi-heure
-- Pour les dates plus anciennes, **HA Linky** se contentera des données quotidiennes. Vous verrez alors une seule grande barre entre 0h et 1h du matin sur votre tableau de bord d'énergie si vous affichez le graphique détaillé d'une telle journée.
+Vous pourrez vérifier le bon fonctionnement de l'add-on en vous rendant dans l'onglet _Journal_ / _Log_, où toutes les informations utiles seront affichées.
 
 ### Tableaux de bord
 
 Pour visualiser les données de **HA Linky** dans vos tableaux de bord d'énergie :
 
-- Ouvrez le menu "_Paramètres_" / "_Settings_", puis "_Tableaux de bord_" / "_Dashboards_", puis "_Énergie_" / "_Energy_"
-- Dans la section "_Réseau électrique_" / "_Electricity grid_", cliquez sur "_Ajouter une consommation_" / "_Add consumption_"
-- Choisissez la statistique `linky:<PRM>` (où `<PRM>` est votre numéro de PRM)
-- Cliquez sur "_Enregistrer_" / "_Save_"
+- Cliquez [ici](https://my.home-assistant.io/redirect/config_energy/), ou ouvrez le menu _Paramètres_ / _Settings_, puis _Tableaux de bord_ / _Dashboards_, puis _Énergie_ / _Energy_
+- Dans la section _Réseau électrique_ / _Electricity grid_, cliquez sur _Ajouter une consommation_ / _Add consumption_
+- Choisissez la statistique correspondant au `consumption name` que vous avez choisi à l'étape de configuration
+- Cliquez sur _Enregistrer_ / _Save_
+
+### Bon à savoir
+
+- Les données d’une journée ne sont pas accessibles en temps réel, il faut attendre **le lendemain de leur mesure** pour pouvoir les récupérer, entre 6h et 10h.
+- Pour les dates récentes (moins de 7 jours), **HA Linky** essaiera de récupérer en priorité des données par demi-heure
+- Pour les dates plus anciennes, **HA Linky** récupèrera seulement des données quotidiennes. Vous verrez alors une seule grande barre entre 0h et 1h du matin sur votre tableau de bord d'énergie si vous affichez le graphique détaillé d'une telle journée.
 
 ### Remise à zéro
 
 En cas de problème, il est toujours possible d'effacer toutes les données créées par **HA Linky**
 
-Revenez sur l'onglet "_Configuration_" de l'add-on et changez la valeur de `consumption action` à `reset`, puis appliquez les modifications et redémarrez l'add-on.
+Revenez sur l'onglet _Configuration_ de l'add-on et changez la valeur de `consumption action` à `reset`, puis appliquez les modifications et redémarrez l'add-on.
 
-Ouvrez ensuite l'onglet "_Journal_" / "_Log_" pour vérifier que la remise à zéro s'est bien déroulée.
+Ouvrez ensuite l'onglet _Journal_ / _Log_ pour vérifier que la remise à zéro s'est bien déroulée.
 
 Au prochain démarrage, si `consumption action` est repassé à `sync`, **HA Linky** réimportera à nouveau toutes vos données. Cette manipulation peut surcharger le serveur de **Conso API**, ne l'utilisez donc que si nécessaire pour ne pas risquer un ban !

config.yaml

@@ -1,6 +1,6 @@
 name: Linky
 description: Sync Energy dashboards with Linky smart meters
-version: 0.1.0
+version: 1.0.0
 slug: linky
 init: false
 url: https://github.com/bokub/ha-linky
@@ -15,8 +15,10 @@ homeassistant_api: true
 options:
   consumption PRM: ''
   consumption token: ''
+  consumption name: 'Linky consumption'
   consumption action: sync
 schema:
   consumption PRM: str?
   consumption token: str?
+  consumption name: str
   consumption action: list(sync|reset)