OVMS3/OVMS.V3/components/vehicle_vweup/src/poll_reply_helper.cpp

/**
 * Project:      Open Vehicle Monitor System
 * Module:       Poll Reply Helper
 *
 * (c) 2020 Soko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "ovms_log.h"
#include "poll_reply_helper.h"

static const char *TAG = "v-vweup";

bool PollReplyHelper::AddNewData(uint16_t pid, uint8_t *data, uint8_t length, uint16_t remain)
{
  // When I have a different PID as last time OR
  // if I'm not waiting for more data from last time...
  if (LastPid != pid || LastRemain == 0) {
    // ...let's fill the data into the store from the beginning
    Store.clear();
  }
  Store.append((char *)data, length);

  LastPid = pid;
  LastRemain = remain;

  // TRUE when all data is here
  // FALSE when we have to wait
  return remain == 0;
}

std::string PollReplyHelper::GetHexString()
{
  stringstream msg;
  msg << "Store[0-" << (Store.size() - 1) << "] =";
  msg << hex << setfill('0');
  for (int i = 0; i < Store.size(); i++) {
    msg << " ";
    // Have to cast to int as uint8_t doesn't work!!
    msg << uppercase << hex << setw(2) << static_cast<int>(Store[i]);
  }
  return msg.str();
}

bool PollReplyHelper::FromUint8(const std::string &info, float &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (1 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromUint8(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    value = NAN;
    return false;
  }

  value = static_cast<float>((uint8_t)Store[0 + bytesToSkip]);
  return true;
}

bool PollReplyHelper::FromUint8(const std::string &info, int &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (1 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromUint8(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    return false;
  }

  value = static_cast<int>((uint8_t)Store[0 + bytesToSkip]);
  return true;
}

bool PollReplyHelper::FromUint16(const std::string &info, float &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (2 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromUint16(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    value = NAN;
    return false;
  }

  value = static_cast<float>((uint16_t)(
            (Store[0 + bytesToSkip] << 8) +
            ((uint16_t)Store[1 + bytesToSkip])));
  return true;
}

bool PollReplyHelper::FromUint24(const std::string &info, float &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (3 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromUint24(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    value = NAN;
    return false;
  }

  value = static_cast<float>((uint32_t)(
            (Store[0 + bytesToSkip] << 16) +
            (Store[1 + bytesToSkip] << 8) +
            ((uint16_t)Store[2 + bytesToSkip])));
  return true;
}

bool PollReplyHelper::FromInt32(const std::string &info, float &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (4 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromInt32(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    value = NAN;
    return false;
  }

  value = static_cast<float>((int32_t)(
            (Store[0 + bytesToSkip] << 24) +
            (Store[1 + bytesToSkip] << 16) +
            (Store[2 + bytesToSkip] << 8) +
            ((uint16_t)Store[3 + bytesToSkip])));
  return true;
}

bool PollReplyHelper::FromInt16(const std::string &info, float &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (2 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromInt16(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    value = NAN;
    return false;
  }

  value = static_cast<float>((int16_t)(
            (Store[0 + bytesToSkip] << 8) +
            (Store[1 + bytesToSkip])));
  return true;
}

bool PollReplyHelper::FromInt8(const std::string &info, int &value, uint8_t bytesToSkip /*= 0*/)
{
  if (Store.size() < (1 + bytesToSkip)) {
    ESP_LOGE(TAG, "%s: Data length=%d is too short for FromInt8(skippedBytes=%u)",
      info.c_str(), Store.size(), bytesToSkip);
    return false;
  }

  value = static_cast<int>((int8_t)Store[0 + bytesToSkip]);
  return true;
}