arduino/src/AgConfigure.cpp

#include "AgConfigure.h"
#include "EEPROM.h"
#include "Libraries/Arduino_JSON/src/Arduino_JSON.h"

const char *CONFIGURATION_CONTROL_NAME[] = {
    [ConfigurationControlLocal] = "local",
    [ConfigurationControlCloud] = "cloud",
    [ConfigurationControlBoth] = "both"};

const char *LED_BAR_MODE_NAMES[] = {
    [LedBarModeOff] = "off",
    [LedBarModePm] = "pm",
    [LedBarModeCO2] = "co2",
};

static bool jsonTypeInvalid(JSONVar root, String validType) {
  String type = JSON.typeof_(root);
  if (type == validType || type == "undefined" || type == "unknown" ||
      type == "null") {
    return false;
  }
  return true;
}

/**
 * @brief Get LedBarMode Name
 *
 * @param mode LedBarMode value
 * @return String
 */
String Configuration::getLedBarModeName(LedBarMode mode) {
  if (mode == LedBarModeOff) {
    return String(LED_BAR_MODE_NAMES[LedBarModeOff]);
  } else if (mode == LedBarModePm) {
    return String(LED_BAR_MODE_NAMES[LedBarModePm]);
  } else if (mode == LedBarModeCO2) {
    return String(LED_BAR_MODE_NAMES[LedBarModeCO2]);
  }
  return String("unknown");
}

/**
 * @brief Save configure to device storage (EEPROM)
 *
 */
void Configuration::saveConfig(void) {
  config._check = 0;
  int len = sizeof(config) - sizeof(config._check);
  uint8_t *data = (uint8_t *)&config;
  for (int i = 0; i < len; i++) {
    config._check += data[i];
  }
#ifdef ESP8266
  for (int i = 0; i < sizeof(config); i++) {
    EEPROM.write(i, data[i]);
  }
#else
  EEPROM.writeBytes(0, &config, sizeof(config));
#endif
  EEPROM.commit();
  logInfo("Save Config");
}

void Configuration::loadConfig(void) {
  bool readSuccess = false;
#ifdef ESP8266
  uint8_t *data = (uint8_t *)&config;
  for (int i = 0; i < sizeof(config); i++) {
    data[i] = EEPROM.read(i);
  }
  readSuccess = true;
#else
  if (EEPROM.readBytes(0, &config, sizeof(config)) == sizeof(config)) {
    readSuccess = true;
  }
#endif

  if (!readSuccess) {
    logError("Load configure failed");
    defaultConfig();
  } else {
    uint32_t sum = 0;
    uint8_t *data = (uint8_t *)&config;
    int len = sizeof(config) - sizeof(config._check);
    for (int i = 0; i < len; i++) {
      sum += data[i];
    }

    if (sum != config._check) {
      logError("Configure validate invalid");
      defaultConfig();
    } else {
      /** Correct configuration parameter value. */
      bool changed = false;
      if ((config.temperatureUnit != 'c') && (config.temperatureUnit != 'f')) {
        config.temperatureUnit = 'c';
        changed = true;
        logError("Temperture unit invalid, set default 'c'");
      }
      if ((config.useRGBLedBar != (uint8_t)LedBarModeCO2) &&
          (config.useRGBLedBar != (uint8_t)LedBarModePm) &&
          (config.useRGBLedBar != (uint8_t)LedBarModeOff)) {
        config.useRGBLedBar = (uint8_t)LedBarModeCO2;
        changed = true;
        logError("LedBarMode invalid, set default: co2");
      }
      if (changed) {
        saveConfig();
      }
    }
  }
}

/**
 * @brief Set configuration default
 *
 */
void Configuration::defaultConfig(void) {
  // Default country is null
  memset(config.country, 0, sizeof(config.country));
  // Default MQTT broker is null.
  memset(config.mqttBroker, 0, sizeof(config.mqttBroker));

  config.configurationControl = ConfigurationControl::ConfigurationControlBoth;
  config.inUSAQI = false; // pmStandard = ugm3
  config.inF = false;
  config.postDataToAirGradient = true;
  config.displayMode = true;
  config.useRGBLedBar = LedBarMode::LedBarModeCO2;
  config.abcDays = 8;
  config.tvocLearningOffset = 12;
  config.noxLearningOffset = 12;
  config.temperatureUnit = 'c';

  saveConfig();
}

/**
 * @brief Show configuration as JSON string message over log
 *
 */
void Configuration::printConfig(void) { logInfo(toString().c_str()); }

/**
 * @brief Construct a new Ag Configure:: Ag Configure object
 *
 * @param debugLog Serial Stream
 */
Configuration::Configuration(Stream &debugLog)
    : PrintLog(debugLog, "Configure") {}

/**
 * @brief Destroy the Ag Configure:: Ag Configure object
 *
 */
Configuration::~Configuration() {}

/**
 * @brief Initialize configuration
 *
 * @return true Success
 * @return false Failure
 */
bool Configuration::begin(void) {
  EEPROM.begin(512);
  loadConfig();
  printConfig();

  return true;
}

/**
 * @brief Parse JSON configura string to local configure
 *
 * @param data JSON string data
 * @param isLocal true of data got from local, otherwise get from Aigradient
 * server
 * @return true Success
 * @return false Failure
 */
bool Configuration::parse(String data, bool isLocal) {
  logInfo("Parse configure: " + data);

  JSONVar root = JSON.parse(data);
  failedMessage = "";
  if (JSON.typeof_(root) == "undefined") {
    failedMessage = "JSON invalid";
    logError(failedMessage);
    return false;
  }
  logInfo("Parse configure success");

  /** Is configuration changed */
  bool changed = false;

  /** Get ConfigurationControl */
  if (isLocal) {
    uint8_t configurationControl = config.configurationControl;
    if (JSON.typeof_(root["configurationControl"]) == "string") {
      String configurationControl = root["configurationControl"];
      if (configurationControl !=
          String(CONFIGURATION_CONTROL_NAME[config.configurationControl])) {
        if (configurationControl ==
            String(CONFIGURATION_CONTROL_NAME
                       [ConfigurationControl::ConfigurationControlLocal])) {
          config.configurationControl =
              (uint8_t)ConfigurationControl::ConfigurationControlLocal;
          changed = true;
        } else if (configurationControl ==
                   String(
                       CONFIGURATION_CONTROL_NAME
                           [ConfigurationControl::ConfigurationControlCloud])) {
          config.configurationControl =
              (uint8_t)ConfigurationControl::ConfigurationControlCloud;
          changed = true;
        } else if (configurationControl ==
                   String(
                       CONFIGURATION_CONTROL_NAME
                           [ConfigurationControl::ConfigurationControlBoth])) {
          config.configurationControl =
              (uint8_t)ConfigurationControl::ConfigurationControlBoth;
          changed = true;
        } else {
          failedMessage = jsonValueInvalidMessage("configurationControl",
                                                  configurationControl);
          jsonInvalid();
          return false;
        }
      }
    } else {
      if (jsonTypeInvalid(root["configurationControl"], "string")) {
        failedMessage =
            jsonTypeInvalidMessage("configurationControl", "string");
        jsonInvalid();
        return false;
      }
    }

    if (changed) {
      changed = false;
      saveConfig();
      configLogInfo(
          "configurationControl",
          String(CONFIGURATION_CONTROL_NAME[configurationControl]),
          String(CONFIGURATION_CONTROL_NAME[config.configurationControl]));
    }

    if ((config.configurationControl ==
         (byte)ConfigurationControl::ConfigurationControlCloud)) {
      failedMessage = "Local configure ignored";
      jsonInvalid();
      return false;
    }
  } else {
    if (config.configurationControl ==
        (byte)ConfigurationControl::ConfigurationControlLocal) {
      failedMessage = "Cloud configure ignored";
      jsonInvalid();
      return false;
    }
  }

  char temperatureUnit = 0;
  if (JSON.typeof_(root["country"]) == "string") {
    String country = root["country"];
    if (country.length() == 2) {
      if (country != String(config.country)) {
        changed = true;
        configLogInfo("country", String(config.country), country);
        snprintf(config.country, sizeof(config.country), country.c_str());
      }
    } else {
      failedMessage = "Country name " + country +
                      " invalid. Find details here (ALPHA-2): "
                      "https://www.iban.com/country-codes";
      jsonInvalid();
      return false;
    }
  } else {
    if (jsonTypeInvalid(root["country"], "string")) {
      failedMessage = jsonTypeInvalidMessage("country", "string");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["pmStandard"]) == "string") {
    String pmStandard = root["pmStandard"];
    bool inUSAQI = true;
    if (pmStandard == getPMStandardString(false)) {
      inUSAQI = false;
    } else if (pmStandard == getPMStandardString(true)) {
      inUSAQI = true;
    } else {
      failedMessage = jsonValueInvalidMessage("pmStandard", pmStandard);
      jsonInvalid();
      return false;
    }

    if (inUSAQI != config.inUSAQI) {
      configLogInfo("pmStandard", getPMStandardString(config.inUSAQI), pmStandard);
      config.inUSAQI = inUSAQI;
      changed = true;
    }
  } else {
    if (jsonTypeInvalid(root["pmStandard"], "string")) {
      failedMessage = jsonTypeInvalidMessage("pmStandard", "string");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["co2CalibrationRequested"]) == "boolean") {
    co2CalibrationRequested = root["co2CalibrationRequested"];
    if(co2CalibrationRequested) {
      logInfo("co2CalibrationRequested: " +
              String(co2CalibrationRequested ? "True" : "False"));
    }
  } else {
    if (jsonTypeInvalid(root["co2CalibrationRequested"], "boolean")) {
      failedMessage =
          jsonTypeInvalidMessage("co2CalibrationRequested", "boolean");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["ledBarTestRequested"]) == "boolean") {
    ledBarTestRequested = root["ledBarTestRequested"];
    if(ledBarTestRequested){
      logInfo("ledBarTestRequested: " +
              String(ledBarTestRequested ? "True" : "False"));
    }
  } else {
    if (jsonTypeInvalid(root["ledBarTestRequested"], "boolean")) {
      failedMessage = jsonTypeInvalidMessage("ledBarTestRequested", "boolean");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["ledBarMode"]) == "string") {
    String mode = root["ledBarMode"];
    uint8_t ledBarMode = LedBarModeOff;
    if (mode == String(LED_BAR_MODE_NAMES[LedBarModeCO2])) {
      ledBarMode = LedBarModeCO2;
    } else if (mode == String(LED_BAR_MODE_NAMES[LedBarModePm])) {
      ledBarMode = LedBarModePm;
    } else if (mode == String(LED_BAR_MODE_NAMES[LedBarModeOff])) {
      ledBarMode = LedBarModeOff;
    } else {
      failedMessage = jsonValueInvalidMessage("ledBarMode", mode);
      jsonInvalid();
      return false;
    }

    if (ledBarMode != config.useRGBLedBar) {
      configLogInfo("useRGBLedBar",
                    String(LED_BAR_MODE_NAMES[config.useRGBLedBar]),
                    String(LED_BAR_MODE_NAMES[ledBarMode]));
      config.useRGBLedBar = ledBarMode;
      changed = true;
    }
  } else {
    if (jsonTypeInvalid(root["ledBarMode"], "string")) {
      failedMessage = jsonTypeInvalidMessage("ledBarMode", "string");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["displayMode"]) == "string") {
    String mode = root["displayMode"];
    bool displayMode = false;
    if (mode == getDisplayModeString(true)) {
      displayMode = true;
    } else if (mode == getDisplayModeString(false)) {
      displayMode = false;
    } else {
      failedMessage = jsonTypeInvalidMessage("displayMode", mode);
      jsonInvalid();
      return false;
    }

    if (displayMode != config.displayMode) {
      changed = true;
      configLogInfo("displayMode", getDisplayModeString(config.displayMode), mode);
      config.displayMode = displayMode;
    }
  } else {
    if (jsonTypeInvalid(root["displayMode"], "string")) {
      failedMessage = jsonTypeInvalidMessage("displayMode", "string");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["abcDays"]) == "number") {
    int abcDays = root["abcDays"];
    if (abcDays <= 0) {
      abcDays = 0;
    }
    if (abcDays != config.abcDays) {
      logInfo("Set abcDays: " + String(abcDays));
      configLogInfo("abcDays", getAbcDayString(config.abcDays),
                    String(getAbcDayString(abcDays)));
      config.abcDays = abcDays;
      changed = true;
    }
  } else {
    if (jsonTypeInvalid(root["abcDays"], "number")) {
      failedMessage = jsonTypeInvalidMessage("abcDays", "number");
      jsonInvalid();
      return false;
    }
  }

  _tvocLearningOffsetChanged = false;
  if (JSON.typeof_(root["tvocLearningOffset"]) == "number") {
    int tvocLearningOffset = root["tvocLearningOffset"];
    if (tvocLearningOffset != config.tvocLearningOffset) {
      changed = true;
      _tvocLearningOffsetChanged = true;
      configLogInfo("tvocLearningOffset", String(config.tvocLearningOffset),
                    String(tvocLearningOffset));
      config.tvocLearningOffset = tvocLearningOffset;
    }
  } else {
    if (jsonTypeInvalid(root["tvocLearningOffset"], "number")) {
      failedMessage = jsonTypeInvalidMessage("tvocLearningOffset", "number");
      jsonInvalid();
      return false;
    }
  }

  _noxLearnOffsetChanged = false;
  if (JSON.typeof_(root["noxLearningOffset"]) == "number") {
    int noxLearningOffset = root["noxLearningOffset"];
    if (noxLearningOffset != config.noxLearningOffset) {
      changed = true;
      _noxLearnOffsetChanged = true;
      configLogInfo("noxLearningOffset", String(config.noxLearningOffset),
                    String(noxLearningOffset));
      config.noxLearningOffset = noxLearningOffset;
    }
  } else {
    if (jsonTypeInvalid(root["noxLearningOffset"], "number")) {
      failedMessage = jsonTypeInvalidMessage("noxLearningOffset", "number");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["mqttBrokerUrl"]) == "string") {
    String broker = root["mqttBrokerUrl"];
    if (broker.length() < sizeof(config.mqttBroker)) {
      if (broker != String(config.mqttBroker)) {
        changed = true;
        configLogInfo("mqttBrokerUrl", String(config.mqttBroker), broker);
        snprintf(config.mqttBroker, sizeof(config.mqttBroker), broker.c_str());
      }
    } else {
      failedMessage =
          "'mqttBroker' value length invalid: " + String(broker.length());
      jsonInvalid();
      return false;
    }
  } else {
    if (jsonTypeInvalid(root["mqttBrokerUrl"], "string")) {
      failedMessage = jsonTypeInvalidMessage("mqttBrokerUrl", "string");
      jsonInvalid();
      return false;
    }
  }

  if (JSON.typeof_(root["temperatureUnit"]) == "string") {
    String unit = root["temperatureUnit"];
    unit.toLowerCase();
    if ((unit == "c") || (unit == "celsius")) {
      temperatureUnit = 'c';
    } else if ((unit == "f") || (unit == "fahrenheit")) {
      temperatureUnit = 'f';
    } else {
      failedMessage = "'temperatureUnit' value '" + unit + "' invalid";
      logError(failedMessage);
      return false;
    }
  } else {
    if (jsonTypeInvalid(root["temperatureUnit"], "string")) {
      failedMessage = jsonTypeInvalidMessage("temperatureUnit", "string");
      jsonInvalid();
      return false;
    }
  }

  if (temperatureUnit != 0 && temperatureUnit != config.temperatureUnit) {
    changed = true;
    configLogInfo("temperatureUnit", String(config.temperatureUnit),
                  String(temperatureUnit));
    config.temperatureUnit = temperatureUnit;
  }

  if (isLocal) {
    if (JSON.typeof_(root["postDataToAirGradient"]) == "boolean") {
      bool post = root["postDataToAirGradient"];
      if (post != config.postDataToAirGradient) {
        changed = true;
        configLogInfo("postDataToAirGradient",
                      String(config.postDataToAirGradient ? "true" : "false"),
                      String(post ? "true" : "false"));
        config.postDataToAirGradient = post;
      }
    } else {
      if (jsonTypeInvalid(root["postDataToAirGradient"], "boolean")) {
        failedMessage =
            jsonTypeInvalidMessage("postDataToAirGradient", "boolean");
        jsonInvalid();
        return false;
      }
    }
  }

  /** Parse data only got from AirGradient server */
  if (isLocal == false) {
    if (JSON.typeof_(root["model"]) == "string") {
      String model = root["model"];
      if (model.length() < sizeof(config.model)) {
        if (model != String(config.model)) {
          changed = true;
          configLogInfo("model", String(config.model), model);
          snprintf(config.model, sizeof(config.model), model.c_str());
        }
      } else {
        failedMessage =
            "'modal' value length invalid: " + String(model.length());
        jsonInvalid();
        return false;
      }
    } else {
      if (jsonTypeInvalid(root["model"], "string")) {
        failedMessage = jsonTypeInvalidMessage("model", "string");
        jsonInvalid();
        return false;
      }
    }
  }

  if (changed) {
    udpated = true;
    saveConfig();
    printConfig();
  } else {
    logInfo("Nothing changed ignore udpate");
    if (ledBarTestRequested || co2CalibrationRequested) {
      udpated = true;
    }
  }
  return true;
}

/**
 * @brief Get current configuration value as JSON string
 *
 * @return String
 */
String Configuration::toString(void) {
  JSONVar root;

  /** "country" */
  root["country"] = String(config.country);

  /** "pmStandard" */
  root["pmStandard"] = getPMStandardString(config.inUSAQI);

  /** co2CalibrationRequested */
  /** ledBarTestRequested */

  /** "ledBarMode" */
  root["ledBarMode"] = getLedBarModeName();

  /** "displayMode" */
  if (config.displayMode) {
    root["displayMode"] = "on";
  } else {
    root["displayMode"] = "off";
  }

  /** "abcDays" */
  root["abcDays"] = config.abcDays;

  /** "tvocLearningOffset" */
  root["tvocLearningOffset"] = config.tvocLearningOffset;

  /** "noxLearningOffset" */
  root["noxLearningOffset"] = config.noxLearningOffset;

  /** "mqttBrokerUrl" */
  root["mqttBrokerUrl"] = String(config.mqttBroker);

  /** "temperatureUnit" */
  root["temperatureUnit"] = String(config.temperatureUnit);

  /** configurationControl */
  root["configurationControl"] =
      String(CONFIGURATION_CONTROL_NAME[config.configurationControl]);

  /** "postDataToAirGradient" */
  root["postDataToAirGradient"] = config.postDataToAirGradient;

  return JSON.stringify(root);
}

/**
 * @brief Temperature unit (F or C)
 *
 * @return true F
 * @return false C
 */
bool Configuration::isTemperatureUnitInF(void) {
  return (config.temperatureUnit == 'f');
}

/**
 * @brief Country name, it's short name ex: TH = Thailand
 *
 * @return String
 */
String Configuration::getCountry(void) { return String(config.country); }

/**
 * @brief PM unit standard (USAQI, ugm3)
 *
 * @return true USAQI
 * @return false ugm3
 */
bool Configuration::isPmStandardInUSAQI(void) { return config.inUSAQI; }

/**
 * @brief Get CO2 calibration ABC time
 *
 * @return int Number of day
 */
int Configuration::getCO2CalibrationAbcDays(void) { return config.abcDays; }

/**
 * @brief Get Led Bar Mode
 *
 * @return LedBarMode
 */
LedBarMode Configuration::getLedBarMode(void) {
  return (LedBarMode)config.useRGBLedBar;
}

/**
 * @brief Get LED bar mode name
 *
 * @return String
 */
String Configuration::getLedBarModeName(void) {
  return getLedBarModeName((LedBarMode)config.useRGBLedBar);
}

/**
 * @brief Get display mode
 *
 * @return true On
 * @return false Off
 */
bool Configuration::getDisplayMode(void) { return config.displayMode; }

/**
 * @brief Get MQTT uri
 *
 * @return String
 */
String Configuration::getMqttBrokerUri(void) {
  return String(config.mqttBroker);
}

/**
 * @brief Get configuratoin post data to AirGradient cloud
 *
 * @return true Post
 * @return false No-Post
 */
bool Configuration::isPostDataToAirGradient(void) {
  return config.postDataToAirGradient;
}

/**
 * @brief Get current configuration control
 *
 * @return ConfigurationControl
 */
ConfigurationControl Configuration::getConfigurationControl(void) {
  return (ConfigurationControl)config.configurationControl;
}

/**
 * @brief CO2 manual calib request, the request flag will clear after get. Must
 * call this after parse success
 *
 * @return true Requested
 * @return false Not requested
 */
bool Configuration::isCo2CalibrationRequested(void) {
  bool requested = co2CalibrationRequested;
  co2CalibrationRequested = false; // clear requested
  return requested;
}

/**
 * @brief LED bar test request, the request flag will clear after get. Must call
 * this function after parse success
 *
 * @return true Requested
 * @return false Not requested
 */
bool Configuration::isLedBarTestRequested(void) {
  bool requested = ledBarTestRequested;
  ledBarTestRequested = false;
  return requested;
}

/**
 * @brief Reset default configure
 */
void Configuration::reset(void) {
  defaultConfig();
  logInfo("Reset to default configure");
  printConfig();
}

/**
 * @brief Get model name, it's usage for offline mode
 *
 * @return String
 */
String Configuration::getModel(void) { return String(config.model); }

bool Configuration::isUpdated(void) {
  bool updated = this->udpated;
  this->udpated = false;
  return updated;
}

String Configuration::jsonTypeInvalidMessage(String name, String type) {
  return "'" + name + "' type invalid, it's should '" + type + "'";
}

String Configuration::jsonValueInvalidMessage(String name, String value) {
  return "'" + name + "' value '" + value + "' invalid";
}

void Configuration::jsonInvalid(void) {
  loadConfig();
  logError(failedMessage);
}

void Configuration::configLogInfo(String name, String fromValue,
                                  String toValue) {
  logInfo(String("Setting '") + name + String("' from '") + fromValue +
          String("' to '") + toValue + String("'"));
}

String Configuration::getPMStandardString(bool usaqi) {
  if (usaqi) {
    return "us-aqi";
  }
  return "ugm3";
}

String Configuration::getDisplayModeString(bool dispMode) { 
  if(dispMode){
    return String("on");
  }
  return String("off");
}

String Configuration::getAbcDayString(int value) { 
  if(value <= 0){
    return String("off");
  }
  return String(value);
}

String Configuration::getFailedMesage(void) { return failedMessage; }

void Configuration::setPostToAirGradient(bool enable) {
  if (enable != config.postDataToAirGradient) {
    config.postDataToAirGradient = enable;
    logInfo("postDataToAirGradient set to: " + String(enable));
    saveConfig();
  } else {
    logInfo("postDataToAirGradient: Ignored set to " + String(enable));
  }
}

bool Configuration::noxLearnOffsetChanged(void) {
  bool changed = _noxLearnOffsetChanged;
  _noxLearnOffsetChanged = false;
  return changed;
}

bool Configuration::tvocLearnOffsetChanged(void) {
  bool changed = _tvocLearningOffsetChanged;
  _tvocLearningOffsetChanged = false;
  return changed;
}

int Configuration::getTvocLearningOffset(void) {
  return config.tvocLearningOffset;
}

int Configuration::getNoxLearningOffset(void) {
  return config.noxLearningOffset;
}

String Configuration::wifiSSID(void) {
  return "airgradient-" + ag->deviceId();
}

String Configuration::wifiPass(void) { return String("cleanair"); }

void Configuration::setAirGradient(AirGradient *ag) { this->ag = ag;}