linky
2.0.2
NB : Debido a que esta herramienta está dirigida a los franceses, la documentación es ... en francés
Este módulo le permite recuperar su API Viage de consumo de enlace y croducción
Se puede usar de 2 maneras:
Tenga en cuenta que necesita un contador de enlaces y un área de cliente de Enedis para poder usar este módulo
linky con npm : npm i -g linkyEn primer lugar, deberá iniciar sesión en su área de cliente de Enedis y darles permiso para compartir sus datos con una aplicación externa
Vaya a conso.boris.sh para dar su acuerdo y recuperar un token
Luego cree una conexión a su cuenta con el siguiente pedido:
linky auth --token < votre-token > Una vez que se guarda su token, puede recuperar su consumo diario, su curva de carga (consumo de media hora) y su consumo máximo por día
# 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-04Si produce electricidad, también puede recuperar su producción diaria y su curva de carga (producción por media 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 En ausencia de parámetros --start y --end , recuperas el consumo / producción / potencia del día 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 Si su token da acceso a los datos de varios PRM, puede especificar el número PRM que se utilizará en cada comando con el 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 Si tiene varios tokens, puede tomar el paso de autenticación y especificar el token para usar en cada comando con el 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 Puede cambiar el formato de visualización de salida gracias al parámetro --format
Los formatos disponibles son json , csv y pretty (por defecto)
linky daily --start 2023-05-01 --end 2023-05-02 --format json Puede guardar sus resultados en un archivo combinando los parámetros --output y --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 Puede ocultar los mensajes y animaciones de progresión gracias al parámetro --quiet para facilitar la integración en los scripts
linky maxpower --quiet --format json | jq ' .interval_reading[0].value 'Para ver ayuda detallada y más ejemplos:
linky --help # 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" },
...
*/
} ) ;
