teleinfo.cpp

Go to the documentation of this file.

#include "teleinfo.h"
#include "esphome/core/log.h"
 
namespace esphome::teleinfo {
 
ESPHOME_LOG_TAG(TAG, "teleinfo");
 
/* Helpers */
static int get_field(char *dest, uint8_t *buf_start, uint8_t *buf_end, int sep, int max_len) {
  uint8_t *field_end;
  int len;
 
  field_end = static_cast<uint8_t *>(memchr(buf_start, sep, buf_end - buf_start));
  if (!field_end)
    return 0;
  len = field_end - buf_start;
  if (len >= max_len)
    return len;
  memcpy(dest, buf_start, len);
  dest[len] = '\0';
 
  return len;
}
/* TeleInfo methods */
bool TeleInfo::check_crc_(const uint8_t *grp, const uint8_t *grp_end) {
  int grp_len = grp_end - grp;
  if (grp_len < this->checksum_area_end_) {
    ESP_LOGE(TAG, "Empty or too short group");
    return false;
  }
  uint8_t raw_crc = grp[grp_len - 1];
  uint8_t crc_tmp = sum_bytes(grp, grp_len - this->checksum_area_end_);
 
  crc_tmp &= 0x3F;
  crc_tmp += 0x20;
  if (raw_crc != crc_tmp) {
    ESP_LOGE(TAG, "bad crc: got %d except %d", raw_crc, crc_tmp);
    return false;
  }
 
  return true;
}
bool TeleInfo::read_chars_until_(bool drop, uint8_t c) {
  uint8_t received;
  int j = 0;
 
  while (available() > 0 && j < 128) {
    j++;
    if (!read_byte(&received))
      break;
    if (received == c)
      return true;
    if (drop)
      continue;
    /*
     * Internal buffer is full, switch to OFF mode.
     * Data will be retrieved on next update.
     */
    if (buf_index_ >= (MAX_BUF_SIZE - 1)) {
      ESP_LOGW(TAG, "Internal buffer full");
      state_ = STATE_OFF;
      return false;
    }
    buf_[buf_index_++] = received;
  }
 
  return false;
}
void TeleInfo::setup() { state_ = STATE_OFF; }
void TeleInfo::update() {
  if (state_ == STATE_OFF) {
    buf_index_ = 0;
    state_ = STATE_ON;
  }
}
void TeleInfo::loop() {
  switch (state_) {
    case STATE_OFF:
      break;
    case STATE_ON:
      /* Dequeue chars until start frame (0x2) */
      if (read_chars_until_(true, 0x2))
        state_ = START_FRAME_RECEIVED;
      break;
    case START_FRAME_RECEIVED:
      /* Dequeue chars until end frame (0x3) */
      if (read_chars_until_(false, 0x3))
        state_ = END_FRAME_RECEIVED;
      break;
    case END_FRAME_RECEIVED:
      uint8_t *buf_finger;
      uint8_t *grp_end;
      uint8_t *buf_end;
      int field_len;
 
      buf_finger = buf_;
      buf_end = buf_ + buf_index_;
 
      /* Each frame is composed of multiple groups starting by 0xa(Line Feed) and ending by
       * 0xd ('\r').
       *
       * Historical mode: each group contains tag, data and a CRC separated by 0x20 (Space)
       * 0xa | Tag | 0x20 | Data | 0x20 | CRC | 0xd
       *     ^^^^^^^^^^^^^^^^^^^^
       * Checksum is computed on the above in historical mode.
       *
       * Standard mode: each group contains tag, data and a CRC separated by 0x9 (\t)
       * 0xa | Tag | 0x9 | Data | 0x9 | CRC | 0xd
       *     ^^^^^^^^^^^^^^^^^^^^^^^^^
       * Checksum is computed on the above in standard mode.
       *
       * Note that some Tags may have a timestamp in Standard mode. In this case
       * the group would looks like this:
       * 0xa | Tag | 0x9 | Timestamp | 0x9 | Data | 0x9 | CRC | 0xd
       *
       * The DATE tag is a special case. The group looks like this
       * 0xa | Tag | 0x9 | Timestamp | 0x9 | 0x9 | CRC | 0xd
       *
       */
      while ((buf_finger = static_cast<uint8_t *>(memchr(buf_finger, (int) 0xa, buf_end - buf_finger)))) {
        /*
         * Make sure timesamp is nullified between each tag as some tags don't
         * have a timestamp
         */
        timestamp_[0] = '\0';
        /* Point to the first char of the group after 0xa */
        buf_finger += 1;
 
        /* Group len */
        grp_end = static_cast<uint8_t *>(memchr(buf_finger, 0xd, buf_end - buf_finger));
        if (!grp_end) {
          ESP_LOGE(TAG, "No group found");
          break;
        }
 
        if (!check_crc_(buf_finger, grp_end))
          continue;
 
        /* Get tag */
        field_len = get_field(tag_, buf_finger, grp_end, separator_, MAX_TAG_SIZE);
        if (!field_len || field_len >= MAX_TAG_SIZE) {
          ESP_LOGE(TAG, "Invalid tag.");
          continue;
        }
 
        /* Advance buf_finger to after the tag and the separator. */
        buf_finger += field_len + 1;
 
        /*
         * If there is two separators and the tag is not equal to "DATE" or
         * historical mode is not in use (separator_ != 0x20), it means there is a
         * timestamp to read first.
         */
        if (std::count(buf_finger, grp_end, separator_) == 2 && strcmp(tag_, "DATE") != 0 && separator_ != 0x20) {
          field_len = get_field(timestamp_, buf_finger, grp_end, separator_, MAX_TIMESTAMP_SIZE);
          if (!field_len || field_len >= MAX_TIMESTAMP_SIZE) {
            ESP_LOGE(TAG, "Invalid timestamp for tag %s", tag_);
            continue;
          }
 
          /* Advance buf_finger to after the first data and the separator. */
          buf_finger += field_len + 1;
        }
 
        field_len = get_field(val_, buf_finger, grp_end, separator_, MAX_VAL_SIZE);
        if (!field_len || field_len >= MAX_VAL_SIZE) {
          ESP_LOGE(TAG, "Invalid value for tag %s", tag_);
          continue;
        }
 
        /* Resume after the group's 0xd; grp_end < buf_end, so this stays in bounds. */
        buf_finger = grp_end + 1;
 
        publish_value_(std::string(tag_), std::string(val_));
      }
      state_ = STATE_OFF;
      break;
  }
}
void TeleInfo::publish_value_(const std::string &tag, const std::string &val) {
  for (auto *element : teleinfo_listeners_) {
    if (tag != element->tag)
      continue;
    element->publish_val(val);
  }
}
void TeleInfo::dump_config() { ESP_LOGCONFIG(TAG, "TeleInfo:"); }
TeleInfo::TeleInfo(bool historical_mode) {
  if (historical_mode) {
    /*
     * Historical mode doesn't contain last separator between checksum and data.
     */
    checksum_area_end_ = 2;
    separator_ = 0x20;
  } else {
    checksum_area_end_ = 1;
    separator_ = 0x9;
  }
}
void TeleInfo::register_teleinfo_listener(TeleInfoListener *listener) { teleinfo_listeners_.push_back(listener); }
 
}  // namespace esphome::teleinfo