j-vizcaino / goteleinfo

Go library to decode Teleinfo frames sent by an electrical meter

goteleinfo: monitor your house electrical current

goteleinfo is a small library capable of decoding Teleinfo frames sent by an electrical meter.

Teleinfo is the protocol used by ERDF (Electricité Réseau Distribution France) electrical meters. Using this protocol, the electrical meter sends status frames periodically (~2 per second) that gives information about your electrical current consumption and status.

The Teleinfo protocol is described in this document

In order to convert read the frames, the Micro Teleinfo or PiTinfo is needed.

Requirements

This library requires Go >= 1.16

Metrics

The library provides counters to track frame reading and decoding errors. Those are stored internally as Prometheus metrics.

• teleinfo_frames_read_total: total number of raw Teleinfo frames read successfully.
• teleinfo_frames_read_errors_total: total number of read errors. This metric is tagged by error_type.
• teleinfo_frames_decoded_total: total number of decoded Teleinfo frames.
• teleinfo_frames_decode_errors_total: total number of frame decoding errors. This is metric is tagged by error_type

Difference between reading and decoding

Bytes coming from the serial port are accumulated by the reader, looking for frame start and frame end markers to extract raw Teleinfo frames. This is called "reading".

Decoding refers to verifying checksum and extracting fields from frame (eg. OPTARIF, HPHC fields, etc...).

Example: serving Teleinfo as JSON frames

A simple HTTP server example is provided in cmd/teleinfo-json that serves the last n frames, JSON encoded. Frames are served in /frames, while Prometheus metrics can be read from /metrics URL.

goteleinfo's Issues

Switch logging to logrus

Add version to software

One way to do this without hardcoding the version in any go file is through ldflags:

$ go build -ldflags "-X main.version=$(VERSION)" ...

Version should be determined according the git short sha or tag, if it exists.

Buffer points when exporter is not ready

In order to not loose any point, points should be buffered when exporter is not ready.
The amount of memorized points should be set by user with sensible defaults.
Given that we get 2 frames/sec and that frames do not consume much memory, a default value of 256 should be memory friendly and tolerate about 2 minutes of downtime.

README: fix broken link to Teleinfo documentation

Exporters should be running in a separate goroutine

Export data to Telegraf

The application should export points to Telegraf in order to benefit from the multiple exporters and aggregators available with this program.

Use a combination of spf13/cobra & spf13/viper to handle configuration

Add a README

Things to document:

• how to install and build
• how to deploy and use
• how to contribute

Add Travis automated build and test