Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bokub committed Sep 11, 2023
1 parent 6594826 commit 71930b2
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@
<img src="https://github.com/bokub/linky/assets/17952318/15aa5983-6c56-4ef0-b2e2-c663bf7f7087" alt="Linky CLI">
</p>

### 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 :

Expand All @@ -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`:

Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit 71930b2

Please sign in to comment.