linky Download - linky Quellcode herunterladen

Linky

NB : Weil dieses Tool für Franzosen gezielt ist, ist die Dokumentation ... in Französisch

Linky Crica

Mit diesem Modul können Sie Ihren Verbindungsverbrauch und Ihre Croduction Vige -API wiederherstellen

Es kann auf 2 Arten verwendet werden:

Im Befehl
Als Node.js -Modul aus einem anderen Programm

Beachten Sie, dass Sie einen Linky -Zähler und einen Enedis -Kundenbereich benötigen, um dieses Modul verwenden zu können

1. Linky Online -Befehl

Einrichtung

Installieren Sie Node.js auf Ihrem Computer. Die minimal unterstützte Version ist Node 16.
- Debian, Ubuntu & Mint Anweisungen
- Windows Installer
- MacOS Installer
Ein Terminal öffnen
Installieren Sie linky mit npm :

npm i -g linky

Verwenden

Authentifizierung

Zunächst müssen Sie sich in Ihren Kundenbereich in Ihrem Enedis -Kunden anmelden und ihnen die Erlaubnis geben, Ihre Daten mit einer externen Anwendung zu teilen

Gehen Sie zu Conso.boris.sh, um Ihre Vereinbarung zu geben und ein Token zurückzuerhalten

Erstellen Sie dann eine Verbindung zu Ihrem Konto mit der folgenden Reihenfolge:

linky auth --token < votre-token >

Datenwiederherstellung

Sobald Ihr Token gespeichert ist, können Sie Ihren täglichen Verbrauch, Ihre Lastkurve (Verbrauch um eine halbe Stunde) und Ihren maximalen Verbrauch pro Tag wiederherstellen

 # 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

Wenn Sie Strom produzieren, können Sie Ihre tägliche Produktion und Ihre Lastkurve (Produktion pro halbe Stunde) auch wiederherstellen, um Ihre tägliche Produktion und Ihre Lastkurve wiederzugewinnen.

 # 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

Standarddaten

In Ermangelung von Parametern --start und --end haben Sie den Verbrauch / die Produktion / die Leistung des Tages zuvor wiederhergestellt

 # 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 und Multi-Token

Wenn Ihr Token Zugriff auf die Daten mehrerer PRMs erteilt, können Sie die PRM -Nummer angeben, die in jedem Befehl mit dem Parameter --prm verwendet werden soll

 # 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

Wenn Sie mehrere Token haben, können Sie den Authentifizierungsschritt durchführen und das Token angeben, das in jedem Befehl mit dem Parameter --token verwendet werden soll -

 # 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

Zusätzliche Parameter

Sie können das Ausgangsanzeigeformat dank des Parameters --format ändern

Die verfügbaren Formate sind json , csv und pretty (standardmäßig)

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

Sie können Ihre Ergebnisse in einer Datei speichern, indem Sie die Parameter --output und --format kombinieren

 # 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

Sie können die Fortschrittsnachrichten und Animationen dank des Parameter --quiet verbergen, um die Integration in Skripte zu erleichtern

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

Um detaillierte Hilfe und weitere Beispiele zu sehen:

linky --help

2. Linky als Node.js -Modul

Einrichtung

 # Depuis un projet Node.js
npm i linky

Verwenden

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