Unduh linky - Unduh Kode Sumber linky

Linky

NB : Karena alat ini ditargetkan untuk orang Prancis, dokumentasinya ... dalam bahasa Prancis

Linky Crica

Modul ini memungkinkan Anda untuk memulihkan konsumsi linky Anda dan API viage croduction

Ini dapat digunakan dalam 2 cara:

Dalam perintah
Sebagai modul Node.js, dari program lain

Perhatikan bahwa Anda memerlukan penghitung tautan dan area pelanggan Enedis untuk dapat menggunakan modul ini

1. Perintah online linky

Fasilitas

Instal node.js di mesin Anda. Versi minimum yang didukung adalah simpul 16.
- Instruksi Debian, Ubuntu & Mint
- Penginstal Windows
- Penginstal MacOS
Buka terminal
Instal linky dengan npm :

npm i -g linky

Menggunakan

Otentikasi

Pertama -tama, Anda harus masuk ke area pelanggan Enedis Anda dan memberi mereka izin untuk membagikan data Anda dengan aplikasi eksternal

Pergi ke conso.boris.sh untuk memberikan persetujuan Anda dan memulihkan token

Kemudian buat koneksi ke akun Anda dengan pesanan berikut:

linky auth --token < votre-token >

Pemulihan data

Setelah token Anda disimpan, Anda dapat memulihkan konsumsi harian, kurva beban Anda (konsumsi setengah jam), dan konsumsi maksimum Anda per hari

 # 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

Jika Anda menghasilkan listrik, Anda juga dapat memulihkan produksi harian dan kurva beban Anda (produksi per setengah jam)

 # 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

Tanggal default

Dengan tidak adanya parameter --start dan --end , Anda memulihkan konsumsi / produksi / kekuatan hari sebelumnya

 # 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 dan multi-token

Jika token Anda memberikan akses ke data beberapa PRM, Anda dapat menentukan nomor PRM yang akan digunakan di setiap perintah dengan parameter --prm

 # 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

Jika Anda memiliki beberapa token, Anda dapat mengambil langkah otentikasi dan menentukan token untuk digunakan di setiap perintah dengan parameter --token

 # 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

Parameter tambahan

Anda dapat mengubah format tampilan output berkat parameter --format

Format yang tersedia adalah json , csv dan pretty (secara default)

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

Anda dapat menyimpan hasil Anda dalam file dengan menggabungkan parameter --output dan --format

 # 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

Anda dapat menyembunyikan pesan dan animasi perkembangan berkat parameter --quiet untuk memfasilitasi integrasi ke dalam skrip

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

Untuk melihat bantuan terperinci dan lebih banyak contoh:

linky --help

2. Linky sebagai modul Node.js

Fasilitas

 # Depuis un projet Node.js
npm i linky

Menggunakan

 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" },
        ...
    */
} ) ;