Skip to content

Latest commit

 

History

History
137 lines (93 loc) · 4.51 KB

README.md

File metadata and controls

137 lines (93 loc) · 4.51 KB
Raw

LinkyPy

PEP8 Docker

LinkyPy is intended to grab Linky (french dedicated energy meter) information through RaspberryPi USB port.

Default behaviour is to store data in an InfluxDB database, but it can be used as a standalone library as you can implement your own callback function.

Retrieved data is computed accordingly to the Enedis specifications (packets, checksums...) available here.

Have a look to my other Github project for an all-in-one RaspberryPi Kubernetes installer: rsaikali/linkypy_k3s. (this includes an easy to install LinkyPy, InfluxDB database and Grafana stack on your RaspberryPi).

Hardware needed

  1. A RaspberryPi, of course.

  2. A Linky energy meter with Teleinfo pins.

  1. A µTeleInfo dongle. It is plugged in the RaspberryPi through USB port and connected to the Teleinfo Linky pins. The USB dongle is available on Tindie.

Make your own plugin

This is a sample plugin class, here we will print Linky information:

class MyPlugin(object):

    def compute(self, data, timestamp):
        print(timestamp)
        for key, value in data.items():
            print(f"{key} = {value}")

Then add your plugin declaration in the configuration file /etc/linkypy/linkypy.yaml:

linkypy:

    (...)

    callbacks:
        - linkypy.callbacks.influxdb_plugin.InfluxDBPlugin
        - your_package.MyPlugin

    (...)

You can now launch linkypy:

linkypy run
(...)
2020-11-21 12:45:11,823
ADCO     = 012345678901
OPTARIF  = HC..
ISOUSC   = 45
HCHC     = 005602128
HCHP     = 007923975
PTEC     = HP..
IINST    = 001
IMAX     = 090
PAPP     = 00460
HHPHC    = A
MOTDETAT = 000000
(...)

Detailed description of fields is available in the Enedis documentation.

Default InfluxDB behaviour

Default callback will store data into an InfluxDB database.

Once installed, simply run the following command to launch the daemon:

linkypy run

Connection information is configured through environment variables:

export INFLUXDB_SERVICE_HOST=influxdb.local
export INFLUXDB_SERVICE_PORT=8086
export INFLUXDB_DATABASE=linky
export INFLUXDB_USERNAME=admin
export INFLUXDB_PASSWORD=password

Only valuable information is stored:

  • HCHP: High price hours (heures pleines) values (in kWh).
  • HCHC: Low price hours (heures creuses) values (in kWh).
  • PAPP: Instant power delivered (in VA, but I personnaly assume it's watts, yes, even if it's not true that's enough for my understanding).

Price calculation and estimation for current month will also be stored.

Prices are now extracted from energy providers websites (PDF).

In my scenario, I use Grafana next to InfluxDB to visualize stored data. Have a look to my other Github project for an all-in-one RaspberryPi Kubernetes installer: rsaikali/linkypy_k3s. This includes LinkyPy, InfluxDB database and Grafana:

Docker build

Current project is available as a Docker image in rsaikali/linkypy

To build your own linux/arm/v7 docker image from another architecture, you'll need a special (experimental) Docker multi-architecture build functionality detailled here: Building Multi-Arch Images for Arm and x86 with Docker Desktop

You'll basically need to activate experimental features and use buildx.

export DOCKER_CLI_EXPERIMENTAL=enabled
docker buildx create --use --name build --node build --driver-opt network=host
docker buildx build --platform linux/arm/v7 -t <your-repo>/linkypy --push .

Credits

Thank you to Charles (https://github.com/hallard) for the µTeleInfo USB dongle and documentation.