MyElectricalData

MyElectricalData is the official client for the MyElectricaData platform. It is designed specifically for users in France with a Linky electric meter to import electricity consumption data from official Enedis APIs.

Data Storage and Export

Data is imported into either a local cache (SQLite) or an external backend (PostgreSQL). Once stored, the data can be exported to the following destinations:

• MQTT
• Home Assistant (via MQTT auto-discovery)
• InfluxDB / VictoriaMetrics
• PostgreSQL

The tool also provides APIs for data access.

All data collected by this integration is stored in a local NoSQL database.

Enedis makes data available on a D+1 basis (the day after the event) starting from 0:00 UTC. The specific availability times are:

• Winter: 01:00 UTC
• Summer: 02:00 UTC

In general, data is available by 10:00 UTC at the latest.

To remove the enedisgateway2mqtt deployment, use the helm uninstall command.

Warning: This command removes all Kubernetes components associated with the chart, including persistent volumes, and deletes the release.

helm uninstall enedisgateway2mqtt

MyElectricalData can be deployed and integrated using several methods:

• Docker: Images are available on Docker Hub.
• Home Assistant: Available as a Hassio Addon.
• Home Assistant UI: Use the Saniho Card for Home Assistant to display Linky data.
• Data Import: Use the Energy Home Assistant import script to move statistics into Home Assistant.

To install the enedisgateway2mqtt gateway (an Enocean to MQTT Gateway and Control Panel) on Kubernetes, use the helm upgrade --install command. You can provide configuration via a values.yaml file or using the --set flag.

Requirements:

• Kubernetes version: >=1.16.0-0
• Dependency: common (version 4.0.1) from https://library-charts.k8s-at-home.com

# Install using a values file
helm upgrade --install enedisgateway2mqtt Chart/ -f values.yaml

# Install using --set flags
helm install enedisgateway2mqtt \
  --set env.TZ="America/New York" \
    m4dm4rtig4n/enedisgateway2mqtt

# Install using a values file with a remote repository
helm upgrade --install enedisgateway2mqtt m4dm4rtig4n/enedisgateway2mqtt -f values.yaml

Configuration is managed via Helm values. You can customize the deployment in two ways:

1. Using values.yaml: Edit the local Chart/values.yaml file. It contains several commented-out suggested values. Note that this chart also supports values from the common library.
2. Using --set flags: Pass parameters directly via the CLI during installation.

Example of setting the timezone via CLI: --set env.TZ="America/New York"

The application runs several background tasks using fastapi_utils.tasks.repeat_every upon startup. These tasks are managed by the Job class:

1. Import Job: Runs every CYCLE seconds (defaulting to 14400s unless configured in config.yaml, with a minimum of cycle_minimun). It calls Job().boot().
2. Home Assistant Export: Runs every 3600 seconds. It calls Job().export_home_assistant(target="ecowatt").
3. Gateway Status: Runs every 600 seconds. It calls Job().get_gateway_status().

The application is a FastAPI web server that can be started by running main.py. It uses uvicorn to serve the APP instance. By default, it listens on 0.0.0.0 at the port specified in your config.yaml.

If the DEV or DEBUG environment variables are set to true, the server will run in reload mode. SSL configuration can also be applied if defined in the application configuration.

python src/main.py

You can deploy the myelectricaldata service using Docker Compose. The service runs the m4dm4rtig4n/myelectricaldata:latest image and exposes the application on port 5000.

Configuration Details

• Volumes: The service maps a local ./data directory to the /data directory inside the container to persist data.
• Environment Variables:
  • TZ: Sets the timezone for the container (defaults to Europe/Paris in the example).
• Ports:
  • 5000:5000: Maps host port 5000 to container port 5000.

version: "3.9"
services:
  myelectricaldata:
    image: m4dm4rtig4n/myelectricaldata:latest
    restart: unless-stopped
    volumes:
      - ./data:/data
    environment:
      TZ: Europe/Paris
    ports:
      - 5000:5000

The application uses a config.yaml file located in the application data path to manage logging behavior.

• Debug Mode: Set the DEBUG environment variable to true (using str2bool logic) to set the logging level to DEBUG. Otherwise, the level defaults to INFO.
• File Logging: Enable file logging by setting log2file: true in config.yaml. When enabled, logs are written to {APPLICATION_PATH_LOG}/myelectricaldata.log and are also mirrored to the console.
• Log Format: The format and date patterns are controlled by internal constants LOG_FORMAT and LOG_FORMAT_DATE.