lains / ticdecodecpp

A library to decode TIC (TeleInformation coming from french meters like Linky)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CI status

C++ TIC decoding library

French meters use a serial communication protocol called TeleInfo for customers (or TIC).

This library is a C++ implementation of decoding algorithms to parse this TIC serial data into interpreted data. It does so with the minimum overhead, without any dynamic allocation, and is thus also well fitted for embedded systems as the Arduino.

LibTeleinfo is another library that does the same job for Arduino.

There are serveral C or C++ implementations available but most of them dynamically allocate buffers and fully parse the TIC data in structures. In contrast, this library uses callbacks to user functions whenever new data is available, offering a view on a statically allocated buffer representing the data. In its most efficient form (when compiler directive __TIC_UNFRAMER_FORWARD_FRAME_BYTES_ON_THE_FLY__ is defined), there is only one static buffer allocated for storing TIC data, and its size (in bytes) is set by the MAX_DATASET_SIZE constant in TIC/DatasetExtractor.h.

This library can parse both standard TIC (9600 bauds) or historical TIC (1200 bauds) streams, and supports decoding horodates.

Using the library

In order for it to decode in real-time, you will have to regularly invoke TIC::Unframer::pushBytes() with all TIC bytes received by the serial port of your device.

There are a few compile-time options to enable/disable some specific code in the library:

  • __TIC_UNFRAMER_FORWARD_FRAME_BYTES_ON_THE_FLY__ preprocessor directive will not cache whole TIC frames but directly forward frame bytes on the fly to the registered callback (which is going to be a dataset extractor most of the time) In such a configuration, intermediate buffers are avoided and the only static buffer allocated will be located int the dataset exrtactor instance used to decode TIC data.
  • __TIC_LIB_USE_STD_STRING__ preprocessor directive will enable toString() support for objects, but will imply a dependency on the stdlib's headers, which may be an unwanted feature for small embedded systems (and is thus customizable).

Running unit tests

To execute unit tests, run the following command from the sources top directory:

make check

About

A library to decode TIC (TeleInformation coming from french meters like Linky)

License:MIT License


Languages

Language:C++ 98.3%Language:Makefile 1.7%