Skip to content

Commit

Permalink
lint README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bugsounet committed Feb 5, 2025
1 parent da796f6 commit 4a07873
Showing 1 changed file with 36 additions and 27 deletions.
63 changes: 36 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# MMM-Linky

Ce module a été spécialement conçu pour les utilisateurs français possédant un compteur Linky.
Ce module a été spécialement conçu pour les utilisateurs français possédant un compteur Linky.

Grâce à une intégration fluide avec Conso API, il permet de récupérer et d'afficher les données de consommation d'énergie directement sur votre miroir.

Si vous choisissez de récupérer les données de l'année précédente une comparaison sera effectuée et un message vous indiquant si vous avec + ou - consommé sera affiché.
<br>Le header est également dynamique et changera en fonction de la période sélectionnée !

Le header est également dynamique et changera en fonction de la période sélectionnée !

Les données sont actualisées chaque jour entre 10h et 13h.

# ScreenShots
## ScreenShots

![Conso 7 derniers jours](https://github.com/user-attachments/assets/055eef27-43bb-478c-a2cb-16a451bac5b4)
![Conso 3 derniers jours](https://github.com/user-attachments/assets/6dacfd38-d78e-4cb3-be22-be8aec980729)
Expand All @@ -19,22 +21,23 @@ Possibilité de choisir entre 4 thèmes de couleur pour le graphique et d'affich
![WithDataLabel](https://github.com/user-attachments/assets/a4196ed6-2289-487d-a4dc-aee6fb35ff06)
![Capture](https://github.com/user-attachments/assets/52c76634-4543-41e0-be96-27326745fa3d)


## Installation
```

```sh
cd ~/MagicMirror/modules
git clone https://github.com/2hdlockness/MMM-Linky
cd MMM-Linky
npm install
```

## Using the module

### Pré-requis :
- Obtenir un token personnel depuis le site https://conso.boris.sh/
- Récupérer son numéro PDL Linky (PRM). Vous ne savez pas où le trouver cliquez [ICI](https://www.enedis.fr/faq/compteur-linky/ou-trouver-le-numero-point-de-livraison-pdl-du-compteur-linky)
### Pré-requis

Pour utiliser ce module, ajoutez-le au tableau modules dans le fichier `config/config.js` :
* Obtenir un token personnel depuis le site <https://conso.boris.sh/>
* Récupérer son numéro PDL Linky (PRM). Vous ne savez pas où le trouver cliquez [ICI](https://www.enedis.fr/faq/compteur-linky/ou-trouver-le-numero-point-de-livraison-pdl-du-compteur-linky)

Pour utiliser ce module, ajoutez-le au tableau modules dans le fichier `config/config.js` :

```js
{
Expand All @@ -43,11 +46,11 @@ Pour utiliser ce module, ajoutez-le au tableau modules dans le fichier `config/c
config: {
prm: "",
token: "",
periode: 1,
annee_n_minus_1: 1,
couleur: 3,
valuebar: 1,
valuebartextcolor: 0,
periode: 1,
annee_n_minus_1: 1,
couleur: 3,
valuebar: 1,
valuebartextcolor: 0
},
},
```
Expand All @@ -68,26 +71,32 @@ Configuration minimale :
## Configuration options

Option|Default|Description
------|------|-----------
---|---|---
`prm`||Votre numéro PDL Linky [VOIR ICI](https://www.enedis.fr/faq/compteur-linky/ou-trouver-le-numero-point-de-livraison-pdl-du-compteur-linky)
`token`||Votre token personnel [CONSO API](https://conso.boris.sh/)
`periode`|1|Choix de la période.<br>1 = Données de la veille<br>2 = 3 derniers jours<br>3 = 7 derniers jours.
`annee_n_minus_1`|1|Récupérer les données de l'année précédente.<br>1 : activer<br>0 : désactiver.
`couleur`|3| 1 : Bleu et Rose<br>2 : Jaune et Vert<br>3 : Blanc et Bleu<br>4 : Orange et Violet.
`valuebar`|1|Affiche les valeurs à l'intérieur des barres<br>1 : afficher<br> 0 : masquer
`valuebartextcolor`|0|Couleur du texte des valeurs<br> 0 : texte noir<br> 1 : texte blanc
`periode`|1|Choix de la période: 1 = Données de la veille -- 2 = 3 derniers jours -- 3 = 7 derniers jours.
`annee_n_minus_1`|1|Récupérer les données de l'année précédente. 1 : activer -- 0 : désactiver.
`couleur`|3| 1 : Bleu et Rose -- 2 : Jaune et Vert -- 3 : Blanc et Bleu -- 4 : Orange et Violet.
`valuebar`|1|Affiche les valeurs à l'intérieur des barres. 1 : afficher -- 0 : masquer
`valuebartextcolor`|0|Couleur du texte des valeurs. 0 : texte noir -- 1 : texte blanc

## Update
```

```sh
cd ~/MagicMirror/modules/MMM-Linky
git reset --hard HEAD && git pull
npm install
```

## Donate:
Si vous aimez ce module et que vous êtes généreux !<br>
## Donate

Si vous aimez ce module et que vous êtes généreux !

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=DQW6PLJLDDB8L)

Merci !

## Credits:
- Author :
- @2hdlockness
- License : MIT
## Credits

* Author : @2hdlockness
* License : MIT

0 comments on commit 4a07873

Please sign in to comment.