linky Download - linky Sourced Code скачать

Линди

NB : Поскольку этот инструмент предназначен для французских людей, документация ... по -французски

Linky Crica

Этот модуль позволяет вам восстановить ваше ликовое потребление и API Croduction Viage API

Это может быть использовано двумя способами:

В команде
Как модуль Node.js, из другой программы

Обратите внимание, что вам нужен счетчик Linky и область клиента Enedis, чтобы использовать этот модуль

1. Команда Linky Online

Средство

Установите node.js на машине. Минимальная поддерживаемая версия - узел 16.
- Debian, Ubuntu & Mint Инструкции
- Установщик Windows
- Установщик macOS
Откройте терминал
Установите linky с npm :

npm i -g linky

Использовать

Аутентификация

Прежде всего, вам придется войти в свою область клиента Enedis и дать им разрешение поделиться своими данными с внешним приложением

Зайдите в conso.boris.sh, чтобы дать ваше соглашение и вернуть жетон

Затем создайте соединение с вашей учетной записью со следующим заказом:

linky auth --token < votre-token >

Восстановление данных

Как только ваш токен будет сохранен, вы можете восстановить ежедневное потребление, кривую нагрузки (потребление на полчаса) и максимальное потребление в день

 # 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

Если вы производите электроэнергию, вы также можете восстановить свою ежедневную производство и кривую нагрузки (производство на полчаса)

 # 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

Даты по умолчанию

В отсутствие параметров --start и --end вы восстанавливаете потребление / производство / мощность дня перед

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

Если ваш токен предоставляет доступ к данным нескольких PRM, вы можете указать номер PRM, который будет использоваться в каждой команде с параметром --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

Если у вас есть несколько токенов, вы можете сделать шаг аутентификации и указать токен для использования в каждой команде с параметром --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

Дополнительные параметры

Вы можете изменить формат вывода отображения благодаря параметру --format

Доступные форматы - json , csv и pretty (по умолчанию)

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

Вы можете сохранить свои результаты в файле, объединив параметры --output и --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

Вы можете скрыть сообщения о прогрессе и анимации благодаря параметру --quiet для облегчения интеграции в сценарии

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

Чтобы увидеть подробную помощь и больше примеров:

linky --help

2. Linky как модуль Node.js

Средство

 # Depuis un projet Node.js
npm i linky

Использовать

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