From 71930b21212a8db4d4a8ac21fecce3c5ed798ed8 Mon Sep 17 00:00:00 2001 From: Boris Kubiak Date: Mon, 11 Sep 2023 15:57:17 +0200 Subject: [PATCH] Update README --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ec73e39..531aa38 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,7 @@ Linky CLI

-### Attention : Cette documentation est valable uniquement pour la version 2 du module. La documentation pour la version 1 est toujours disponible sur la [branche v1](https://github.com/bokub/linky/tree/v1#readme) - -Ce module vous permet de récupérer votre consommation et production électrique Linky via les API _"Token V3"_ et _"Metering Data V5"_ d'Enedis +Ce module vous permet de récupérer votre consommation et production électrique Linky via le service [Conso API](https://conso.boris.sh/) Il peut s'utiliser de 2 façons : @@ -29,9 +27,9 @@ Notez qu'il vous faut un compteur Linky et un espace client Enedis pour pouvoir ### Installation 1. Installez [Node.js](https://nodejs.org/fr/download) sur votre machine. La version minimale supportée est Node 16. - - [Instructions Debian, Ubuntu & Mint](https://github.com/nodesource/distributions#installation-instructions) - - [Installateur Windows](https://nodejs.org/dist/v18.16.0/node-v18.16.0-x86.msi) - - [Installateur MacOS](https://nodejs.org/dist/v18.16.0/node-v18.16.0.pkg) + - [Instructions Debian, Ubuntu & Mint](https://github.com/nodesource/distributions#installation-instructions) + - [Installateur Windows](https://nodejs.org/dist/v18.16.0/node-v18.16.0-x86.msi) + - [Installateur MacOS](https://nodejs.org/dist/v18.16.0/node-v18.16.0.pkg) 2. Ouvrez un terminal 3. Installez `linky` avec `npm`: @@ -182,8 +180,8 @@ session.userAgent = 'Mon super service'; // Récupère la consommation quotidienne du 1er au 3 mai 2023 session.getDailyConsumption('2023-05-01', '2023-05-04').then((result) => { - console.log(result); - /* + console.log(result); + /* { "reading_type": { "unit": "Wh", @@ -200,8 +198,8 @@ session.getDailyConsumption('2023-05-01', '2023-05-04').then((result) => { // Récupère la puissance moyenne consommée le 1er mai 2023, sur un intervalle de 30 min session.getLoadCurve('2023-05-01', '2023-05-02').then((result) => { - console.log(result); - /* + console.log(result); + /* { "reading_type": { "unit": "W", @@ -217,8 +215,8 @@ session.getLoadCurve('2023-05-01', '2023-05-02').then((result) => { // Récupère la puissance maximale de consommation atteinte quotidiennement du 1er au 3 mai 2023 session.getMaxPower('2023-05-01', '2023-05-04').then((result) => { - console.log(result); - /* + console.log(result); + /* { "reading_type": { "unit": "VA", @@ -235,8 +233,8 @@ session.getMaxPower('2023-05-01', '2023-05-04').then((result) => { // Récupère la production quotidienne du 1er au 3 mai 2023 session.getDailyProduction('2023-05-01', '2023-05-04').then((result) => { - console.log(result); - /* + console.log(result); + /* { "reading_type": { "unit": "Wh", @@ -253,8 +251,8 @@ session.getDailyProduction('2023-05-01', '2023-05-04').then((result) => { // Récupère la puissance moyenne produite le 1er mai 2023, sur un intervalle de 30 min session.getProductionLoadCurve('2023-05-01', '2023-05-02').then((result) => { - console.log(result); - /* + console.log(result); + /* { "reading_type": { "unit": "W",