Tasmota/lib/lib_div/LibTeleinfo/src/LibTeleinfo.h

// **********************************************************************************
// Driver definition for French Teleinfo
// **********************************************************************************
// Creative Commons Attrib Share-Alike License
// You are free to use/extend this library but please abide with the CC-BY-SA license:
// http://creativecommons.org/licenses/by-sa/4.0/
//
// For any explanation about teleinfo ou use , see my blog
// http://hallard.me/category/tinfo
//
// Code based on following datasheet
// http://www.erdf.fr/sites/default/files/ERDF-NOI-CPT_02E.pdf
//
// Written by Charles-Henri Hallard (http://hallard.me)
//
// History : V1.00 2015-06-14 - First release
//           V2.00 2020-06-11 - Integration into Tasmota
//           V2.01 2020-08-11 - Merged LibTeleinfo official and Tasmota version
//                              Added support for new standard mode of linky smart meter
//
// All text above must be included in any redistribution.
//
// Edit : Tab size set to 2 but I converted tab to sapces
//
// **********************************************************************************

#ifndef LibTeleinfo_h
#define LibTeleinfo_h

#ifdef __arm__
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#define boolean bool
#endif

#ifdef ARDUINO
#include <Arduino.h>
#include <time.h>       /* struct tm */
#endif

// Define this if you want library to be verbose
//#define TI_DEBUG

// I prefix debug macro to be sure to use specific for THIS library
// debugging, this should not interfere with main sketch or other
// libraries
void AddLog(uint32_t loglevel, PGM_P formatP, ...);
#define TI_Errorf(...) AddLog(LOG_LEVEL_ERROR, __VA_ARGS__);
#ifdef TI_DEBUG
  // Tasmota build
  #ifdef CODE_IMAGE_STR
      // Only TI_Debugf() can work with Tasmota
      #define TI_Debugf(...) AddLog(LOG_LEVEL_DEBUG, __VA_ARGS__);
      #define TI_Debugflush  {}
  #else
    #ifdef ESP8266
      #define TI_Debug(x)    Serial1.print(x)
      #define TI_Debugln(x)  Serial1.println(x)
      #define TI_Debugf(...) Serial1.printf(__VA_ARGS__)
      #define TI_Debugflush  Serial1.flush
    #else
      #define TI_Debug(x)    Serial.print(x)
      #define TI_Debugln(x)  Serial.println(x)
      #define TI_Debugf(...) Serial.printf(__VA_ARGS__)
      #define TI_Debugflush  Serial.flush
    #endif
  #endif
#else
  #define TI_Debug(x)    {}
  #define TI_Debugln(x)  {}
  #define TI_Debugf(...) {}
  #define TI_Debugflush  {}
#endif

// For 4 bytes Aligment boundaries
#if defined (ESP8266) || defined (ESP32)
#define ESP_allocAlign(size)  ((size + 3) & ~((size_t) 3))
#endif

#pragma pack(push)  // push current alignment to stack
#pragma pack(1)     // set alignment to 1 byte boundary

// Linked list structure containing all values received
typedef struct _ValueList ValueList;
struct _ValueList
{
  ValueList *next; // next element
  time_t  ts;      // TimeStamp of data if any
  uint8_t checksum;// checksum
  uint8_t flags;   // specific flags
  char  * name;    // LABEL of value name
  char  * value;   // value
};

#pragma pack(pop)

// Library state machine
enum _Mode_e {
  TINFO_MODE_HISTORIQUE,  // Legacy mode (1200)
  TINFO_MODE_STANDARD     // Standard mode (9600)
};

// Library state machine
enum _State_e {
  TINFO_INIT,     // We're in init
  TINFO_WAIT_STX, // We're waiting for STX
  TINFO_WAIT_ETX, // We had STX, We're waiting for ETX
  TINFO_READY     // We had STX AND ETX, So we're OK
};

// what we done with received value (also for callback flags)
#define TINFO_FLAGS_NONE     0x00
#define TINFO_FLAGS_NOTHING  0x01
#define TINFO_FLAGS_ADDED    0x02
#define TINFO_FLAGS_EXIST    0x04
#define TINFO_FLAGS_UPDATED  0x08
#define TINFO_FLAGS_ALERT    0x80 /* This will generate an alert */

// Local buffer for one line of teleinfo
// maximum size for Standard
#define TINFO_BUFSIZE  128

// Teleinfo start and end of frame characters
#define TINFO_STX 0x02
#define TINFO_ETX 0x03
#define TINFO_HT  0x09
#define TINFO_SGR '\n' // start of group
#define TINFO_EGR '\r' // End of group

typedef void (*_fn_ADPS) (uint8_t);
typedef void (*_fn_data) (ValueList *, uint8_t);
typedef void (*_fn_new_frame) (ValueList *);
typedef void (*_fn_updated_frame) (ValueList *);

class TInfo
{
  public:
    TInfo();
    void          init(_Mode_e mode); // mode MUST be specified
    _State_e      process (char c);
    void          attachADPS(void (*_fn_ADPS)(uint8_t phase));
    void          attachData(void (*_fn_data)(ValueList * valueslist, uint8_t state));
    void          attachNewFrame(void (*_fn_new_frame)(ValueList * valueslist));
    void          attachUpdatedFrame(void (*_fn_updated_frame)(ValueList * valueslist));
    ValueList *   addCustomValue(char * name, char * value, uint8_t * flags);
    ValueList *   getList(void);
    uint8_t       valuesDump(void);
    char *        valueGet(char * name, char * value);
    char *        valueGet_P(const char * name, char * value);
    boolean       listDelete();
    unsigned char calcChecksum(char *etiquette, char *valeur, char *horodate=NULL) ;

  private:
    void          clearBuffer();
    ValueList *   valueAdd (char * name, char * value, uint8_t checksum, uint8_t * flags, char * horodate=NULL);
    boolean       valueRemove (char * name);
    boolean       valueRemoveFlagged(uint8_t flags);
    int           labelCount();
    uint32_t      horodate2Timestamp( char * pdate) ;
    void          customLabel( char * plabel, char * pvalue, uint8_t * pflags) ;
    ValueList *   checkLine(char * pline) ;

    _Mode_e   _mode; // Teleinfo mode (legacy/historique vs standard)
    _State_e  _state; // Teleinfo machine state
    ValueList _valueslist;   // Linked list of teleinfo values
    char      _recv_buff[TINFO_BUFSIZE]; // line receive buffer
    char      _separator;
    uint8_t   _recv_idx;  // index in receive buffer
    boolean   _frame_updated; // Data on the frame has been updated
    void      (*_fn_ADPS)(uint8_t phase);
    void      (*_fn_data)(ValueList * valueslist, uint8_t state);
    void      (*_fn_new_frame)(ValueList * valueslist);
    void      (*_fn_updated_frame)(ValueList * valueslist);

    //volatile uint8_t *dcport;
    //uint8_t dcpinmask;
};

#endif