Download de linky - download do código fonte linky

Linky

NB : Como essa ferramenta é direcionada para os franceses, a documentação é ... em francês

Linky Crica

Este módulo permite que você recupere sua API de consumo e crodução de linky

Pode ser usado de 2 maneiras:

No comando
Como um módulo Node.js, de outro programa

Observe que você precisa de um contador de linky e uma área de cliente da ENEDIS para poder usar este módulo

1. Linky Online Command

Instalação

Instale o Node.js em sua máquina. A versão mínima suportada é o nó 16.
- Debian, Ubuntu & Mint Instruções
- Instalador do Windows
- Instalador de macos
Abra um terminal
Instale linky com npm :

npm i -g linky

Usar

Autenticação

Primeiro de tudo, você terá que fazer login na área do cliente da ENEDIS e dar -lhes permissão para compartilhar seus dados com um aplicativo externo

Vá para conso.boris.sh para dar seu acordo e recuperar um token

Em seguida, crie uma conexão com sua conta com o seguinte pedido:

linky auth --token < votre-token >

Recuperação de dados

Depois que seu token for salvo, você pode recuperar seu consumo diário, sua curva de carga (consumo por meia hora) e seu consumo máximo por dia

 # 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

Se você produzir eletricidade, também pode recuperar sua produção diária e sua curva de carga (produção por meia hora)

 # 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

Datas padrão

Na ausência de parâmetros --start e --end , você recupera o consumo / produção / poder do dia anterior

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

Se o seu token fornecer acesso aos dados de vários PRMs, você poderá especificar o número PRM a ser usado em cada comando com o parâmetro --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

Se você tiver vários tokens, pode seguir a etapa de autenticação e especificar o token para usar em cada comando com o parâmetro --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

Parâmetros adicionais

Você pode alterar o formato de exibição de saída graças ao parâmetro --format

Os formatos disponíveis são json , csv e pretty (por padrão)

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

Você pode salvar seus resultados em um arquivo combinando os parâmetros --output e --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

Você pode ocultar as mensagens e animações de progressão graças ao parâmetro --quiet para facilitar a integração nos scripts

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

Para ver ajuda detalhada e mais exemplos:

linky --help

2. Linky como um módulo Node.js

Instalação

 # Depuis un projet Node.js
npm i linky

Usar

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