03. Configuration

Nom du ficher : config.yaml

Chemin dans le conteneur docker : /data/config.yaml

Un template est disponible sur le repo config.yaml

Champs	Information	Défaut
cycle	Permet de définir l'interval d'exécution du job d'importation des données (minimun 3600) Plus vous baissez cette valeur, plus vous avez de chance d'atteindre les quota rapidement	14400
debug	Affichage des logs en mode Debug	False
log2file	Permet d'activer la persistance des logs dans le fichier /log/myelectricaldata.log du conteneur (Ne pas oublier de mapper le volume pour la persistance).	False
storage_uri	Permet de configurer une base de donnée externe pour le cache interne à l'application (seul PostgreSQL est supporté pour l'instant) Exemple: storage_uri: postgresql://myelectricaldata:myelectricaldata@postgres:5432/myelectricaldata	""
wipe_cache	Permet de faire une purge des données du cache	False
wipe_influxdb	Permet de faire une purge des données dans InfluxDB	False
port	Port d'écoute du service	5000
home_assistant	Voir block home_assistant	{}
home_assistant_ws	Voir block home_assistant_ws	{}
influxdb	Voir block influxdb	{}
mqtt	Voir block mqtt	{}
myelectricaldata	Voir block myelectricaldata	{}
tempo	Voir block tempo	{}
ssl	Voir block ssl	{}

home_assistant

Permet d'activer la création des "sensor" automatique dans Home Assistant via le MQTT Discovery.

Champs	Information	Défaut
enable	Activation ou non des exports MQTT au format Home Assistant (auto-discovery)	False
discovery_prefix	Préfixe configuré dans Home Assistant pour l'auto-discovery	homeassistant

home_assistant_ws

Permet d'envoyer les statistiques vers l'onglet Energy de Home Assistant via le WebSocket.

Champs	Information	Défaut
enable	Activation ou non des exports vers l'onglet "Energy" de Home Assistant (WebSocket)	False
ssl	Active ou non le SSL (WSS) sur le WebSocket (A activer si l'url de votre Home Assistant est en HTTPS)	True
token	Token généré dans votre profile Home Assistant (Jetons d'accès longue durée)
url	URL vers votre Home Assistant (Interne ou Externe)
max_date	Permet de limiter la date d'export des données vers l'onglet "Energy" de HA

influxdb

Version supportée minimun 1.8

Champs	Information	Défaut
enable	Activation ou non des exports vers InfluxDB	False
hostname	Addresse IP ou domaine vers votre serveur InfluxDB	influxdb
port	Port du serveur InfluxDB	8086
token	Token en V2 & USERNAME:PASSWORD pour la V1	myelectricaldata
org	Nom de l'organisation V2, en V1 mettre "-"	myelectricaldata
bucket	Nom du bucket en V2 et "DATABASE/RETENTION" en V1	myelectricaldata
method	synchronous / asynchronous / batching	synchronous
batching_options	https://github.com/influxdata/influxdb-client-python#batching

method & batching_options :

Ces 2 propriétés vont vous permettre de jouer sur la rapidité d'importation dans l'influxdb.

ATTENTION, en fonction de la configuration, vous risquez de surcharger votre serveur.

• synchronous : Mode classique assez lent sur l'importation, mais évite de surcharger le CPU & la mémoire.
• asynchronous : Mode "bourrin", la totalité des valeurs sera envoyée en même temps et donc consommera énormément de ressources le temps du traimement
• batching : Mode custom qui va vous permettre de jouer sur divers paramètres. A utiliser si le mode synchronous est encore trop gourmand. Plus d'informations disponible ici.

Configuration par version :

v1.8 :

influxdb:
  enable: 'true'
  hostname: influxdb
  port: 8086
  token: USERNAME:PASSWORD
  org: "-"
  bucket: "DATABASE/RETENTION"
  method: asynchronous

v2.X :

influxdb:
  enable: 'true'
  hostname: influxdb
  port: 8086
  token: MY_TOKEN
  org: MY_ORG
  bucket: MY_BUCKET
  method: batching

mqtt

Champs	Information	Défaut
enable	Activation ou non des exports vers MQTT	False
hostname	Addresse IP ou domaine vers votre serveur MQTT	influxdb
port	Port du serveur MQTT	8086
username	Mettre "null" si pas d'authentification	myelectricaldata
password	Mettre "null" si pas d'authentification	myelectricaldata
prefix	Préfixe de la queue dans MQTT	myelectricaldata
client_id	ID de connexion UNIQUE sur la totalité des clients	myelectricaldata
retain	Activation de la persistance dans MQTT	True
qos	Inutile de mettre plus de 0 (a part pour surcharger votre réseau)	0

myelectricaldata

Dictionnaire avec comme clef votre Point de Livraison (entre double quote) contenant toute sa configuration.

Champs	Information	Défaut
token	Votre token récupéré suite à la demande de consentement sur la passerelle	""
name	Alias de votre point livraison pour faciliter la navigation	""
addresses	Récupération des coordonnées du point de livraison	False
cache	Activation du cache sur la passerelle	True
consumption	Activation de la collecte de consommation journalière	True
consumption_detail	Activation de la collecte de consommation horaire	True
consumption_max_date	Permet de définir la date de fin de récupération de la consommation journalier	""
consumption_detail_max_date	Permet de définir la date de fin de récupération de la consommation détaillée	""
consumption_price_base	Prix d'achat du kW sans forfait HP/HC	0
consumption_price_hc	Prix d'achat du kW en Heure Creuse	0
consumption_price_hp	Prix d'achat du kW en Heure Pleine	0
enable	Activation du PDL	True
offpeak_hours_0	Heure creuse du Lundi	""
offpeak_hours_1	Heure creuse du Mardi	""
offpeak_hours_2	Heure creuse du Mercredi	""
offpeak_hours_3	Heure creuse du Jeudi	""
offpeak_hours_4	Heure creuse du Vendredi	""
offpeak_hours_5	Heure creuse du Samedi	""
offpeak_hours_6	Heure creuse du Dimanche	""
plan	Votre type de plan BASE, HP/HC, TEMPO	BASE
production	Activation de la collecte de production journalière	False
production_detail	Activation de la collecte de production horaire	False
production_price	Prix de revente à Enedis (Inutile pour l'instant)	0
production_max_date	Permet de la date boutoir de récupération de la production journalière	""
production_detail_max_date	Permet de la date boutoir de récupération de la production détaillée	""
refresh_addresse	Permet de forcer un rafraichissement des informations "postale" dans le cache	False
refresh_contract	Permet de forcer un rafraichissement des informations du contrat dans le cache	False

Si les valeurs consumption_max_date, consumption_max_detail_date, production_max_date, ** production_detail_max_date** ne sont pas défini, ce sera la date de début de contrat remonté par Enedis qui sera prise en compte.

offpeak_hours

Les champs offpeak_hours_X vont vous permettre de définir vos seuils d'heure creuse/pleine de votre point de livraison si Enedis ne renvoie pas l'information.

Même si votre forfait est en BASE, je vous recommande de saisir vos HC/HP afin de savoir si votre mode de consommation est plus adapté au forfait BASE ou HP/HC.

Plusieurs mode de HP/HC ?

Pour les utilisateurs ayant différentes plages en fonction des jours de semaine ou weekend, il est nécessaire de renseigner la configuration manuellement, car les API d'Enedis ne renvoie pas toutes les informations...

Exemple :

offpeak_hours_0: 3H40-8h10;12H40-16H10
offpeak_hours_1: 3H40-8h10;12H40-16H10
offpeak_hours_2: 0H00-23h59
offpeak_hours_3: 3H40-8h10;12H40-16H10
offpeak_hours_4: 3H40-8h10;12H40-16H10
offpeak_hours_5: 0H00-23h59
offpeak_hours_6: 0H00-23h59

tempo

Champs	Information	Défaut
enable	Activation ou non l'import des données Tempo depuis la passerelle.	False

ssl

Champs	Information	Défaut
gateway	Permet d'activer/désactiver le check SSL de la passerelle https://myelectricaldata.fr	True
certfile	Permet de passer un certifcat auto signée	None
keyfile	Permet de passer une clef de certificat auto signée	None