Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/bokub/linky

🔌 CLI tool to retrieve Linky smart meters data
https://github.com/bokub/linky
api consumption electricity enedis linky nodejs power production
Last synced: about 1 month ago
JSON representation
🔌 CLI tool to retrieve Linky smart meters data
Host: GitHub
URL: https://github.com/bokub/linky
Owner: bokub
License: gpl-3.0
Created: 2018-10-31T16:30:36.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-02-12T14:09:16.000Z (7 months ago)
Last Synced: 2024-07-19T07:12:18.282Z (about 2 months ago)
Topics: api, consumption, electricity, enedis, linky, nodejs, power, production
Language: TypeScript
Homepage:
Size: 720 KB
Stars: 213
Watchers: 15
Forks: 19
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Linky

[![Version](https://runkit.io/bokub/npm-version/branches/master/linky?style=flat)](https://www.npmjs.com/package/linky)

[![Build Status](https://flat.badgen.net/github/checks/bokub/linky?label=tests)](https://github.com/bokub/linky/actions/workflows/run.yml?query=branch%3Amaster)

[![Codecov](https://flat.badgen.net/codecov/c/github/bokub/linky/master)](https://codecov.io/gh/bokub/linky)

[![Downloads](https://flat.badgen.net/npm/dy/linky?color=FF9800)](https://www.npmjs.com/package/linky)

[![Node version](https://flat.badgen.net/badge/Node.js/>=%2016/blue)](https://github.com/bokub/prettier-config)

[![Code style](https://flat.badgen.net/badge/code%20style/prettier/ff69b4)](https://github.com/bokub/prettier-config)

> **N.B**: Because this tool is targeted for french people, the documentation is...in french



  



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 :

1. [En ligne de commande](#1-linky-en-ligne-de-commande)

2. [En tant que module Node.js](#2-linky-comme-module-nodejs), depuis un autre programme

Notez qu'il vous faut un compteur Linky et un espace client Enedis pour pouvoir utiliser ce module

## 1. Linky en ligne de commande

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

2. Ouvrez un terminal

3. Installez `linky` avec `npm`:

```bash

npm i -g linky

```

### Utilisation

#### Authentification

Avant toute chose, il faudra vous connecter à votre espace client Enedis et leur donner l'autorisation de partager vos données avec une application extérieure

Rendez-vous sur [conso.boris.sh](https://conso.boris.sh) pour donner votre accord et récupérer un token

Puis, créez une connexion à votre compte avec la commande suivante :

```bash

linky auth --token 

```

#### Récupération des données

Une fois votre token sauvegardé, vous pourrez récupérer votre consommation quotidienne, votre courbe de charge (consommation par demi-heure), et votre consommation maximale par jour

```bash

# Récupère la consommation quotidienne du 1er au 3 mai 2023

linky daily --start 2023-05-01 --end 2023-05-04

# Récupère la puissance moyenne consommée le 1 mai 2023, sur un intervalle de 30 min

linky loadcurve --start 2023-05-01 --end 2023-05-02

# Récupère la puissance maximale de consommation atteinte quotidiennement du 1er au 3 mai 2023

linky maxpower --start 2023-05-01 --end 2023-05-04

```

Si vous produisez de l'électricité, vous pouvez également récupérer votre production quotidienne et votre courbe de charge (production par demi-heure)

```bash

# Récupère la production quotidienne du 1er au 3 mai 2023

linky dailyprod --start 2023-05-01 --end 2023-05-04

# Récupère la puissance moyenne produite le 1 mai 2023, sur un intervalle de 30 min

linky loadcurveprod --start 2023-05-01 --end 2023-05-02

```

#### Dates par défaut

En l'absence des paramètres `--start` et `--end`, vous récupérez la consommation / production / puissance de la veille

```bash

# Récupère la consommation de la journée d'hier

linky daily

# Récupère la puissance moyenne consommée pendant la journée d'hier, sur un intervalle de 30 min

linky loadcurve

# Récupère la puissance maximale de consommation atteinte durant la journée d'hier

linky maxpower

# Récupère la production de la journée d'hier

linky dailyprod

# Récupère la production moyenne consommée pendant la journée d'hier, sur un intervalle de 30 min

linky loadcurveprod

```

#### Multi-PRM et multi-token

Si votre token donne accès aux données de plusieurs PRMs, vous pouvez préciser le numéro de PRM à utiliser dans chaque commande avec le paramètre `--prm`

```bash

# Récupère la consommation de la veille pour le compteur 111222333

linky daily --prm 111222333

# Récupère la production de la veille pour le compteur 777888999

linky dailyprod --prm 777888999

```

Si vous possédez plusieurs tokens, vous pouvez passer l'étape d'authentification et préciser le token à utiliser dans chaque commande avec le paramètre `--token`

```bash

# Récupère la consommation de la veille avec le token aaa.bbb.ccc

linky daily --token aaa.bbb.ccc

# Récupère la production de la veille avec le token xxx.yyy.zzz

linky dailyprod --token xxx.yyy.zzz

```

#### Paramètres supplémentaires

Vous pouvez changer le format d'affichage de sortie grâce au paramètre `--format`

Les formats disponibles sont `json`, `csv` et `pretty` (par défaut)

```bash

linky daily --start 2023-05-01 --end 2023-05-02 --format json

```

Vous pouvez sauvegarder vos résultats dans un fichier en combinant les paramètres `--output` et `--format`

```bash

# Sauvegarde la courbe de charge de la veille au format JSON

linky loadcurve --output chemin/vers/ma_conso.json --format json

# Sauvegarde une semaine de consommation au format CSV

linky daily --start 2023-05-01 --end 2023-05-07 --output chemin/vers/ma_conso.csv --format csv

```

Vous pouvez masquer les messages et animations de progression grâce au paramètre `--quiet` afin de faciliter l'intégration dans des scripts

```bash

linky maxpower --quiet --format json | jq '.interval_reading[0].value'

```

Pour voir l'aide détaillée et plus d'exemples :

```bash

linky --help

```

## 2. Linky comme module Node.js

### Installation

```bash

# Depuis un projet Node.js

npm i linky

```

### Utilisation

```js

import { Session } from 'linky';

// Créez une session à partir du token

const token = 'xxx.yyy.zzz';

let session = new Session(token);

// Si le token permet d'accéder à plusieurs PRMs, vous pouvez préciser celui à utiliser

const prm = '123456';

session = new Session(token, prm);

// Si vous prévoyez de rendre votre application/service/module accessible au grand public,

// ajoutez un User-Agent au format string à la session.

// Celui-ci doit permettre d'identifier l'origine des requêtes envoyées à Conso API.

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);

  /*

    {

      "reading_type": {

        "unit": "Wh",

        "measurement_kind": "energy"

      },

      "interval_reading": [

        { "value": "12873", "date": "2023-05-01" },

        { "value": "12296", "date": "2023-05-02" },

        { "value": "14679", "date": "2023-05-03" }

      ]

    ...

    */

});

// 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);

  /*

    {

      "reading_type": {

        "unit": "W",

        "measurement_kind": "power"

      },

      "interval_reading": [

        { "value": "752", "date": "2023-05-01 00:30:00" },

        { "value": "346", "date": "2023-05-01 01:00:00" },

        { "value": "250", "date": "2023-05-01 01:30:00" },

        ...

    */

});

// 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);

  /*

    {

      "reading_type": {

        "unit": "VA",

        "measurement_kind": "power"

      },

      "interval_reading": [

        { "value": "4638", "date": "2023-05-01 12:06:20" },

        { "value": "4410", "date": "2023-05-02 19:27:46" },

        { "value": "3570", "date": "2023-05-03 21:42:12" }

      ]

    ...

    */

});

// 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);

  /*

    {

      "reading_type": {

        "unit": "Wh",

        "measurement_kind": "energy"

      },

      "interval_reading": [

        { "value": "12873", "date": "2023-05-01" },

        { "value": "12296", "date": "2023-05-02" },

        { "value": "14679", "date": "2023-05-03" }

      ]

    ...

    */

});

// 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);

  /*

    {

      "reading_type": {

        "unit": "W",

        "measurement_kind": "power"

      },

      "interval_reading": [

        { "value": "752", "date": "2023-05-01 00:30:00" },

        { "value": "346", "date": "2023-05-01 01:00:00" },

        { "value": "250", "date": "2023-05-01 01:30:00" },

        ...

    */

});

```