ESP32_ChinaDieselHeater_Con.../Arduino/BTCDieselHeater/src/Utility/NVStorage.h

241 lines
6.5 KiB
C++

/*
* This file is part of the "bluetoothheater" distribution
* (https://gitlab.com/mrjones.id.au/bluetoothheater)
*
* Copyright (C) 2018 Ray Jones <ray@mrjones.id.au>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
#ifndef __BTC_NV_STORAGE_H__
#define __BTC_NV_STORAGE_H__
#include "../RTC/Timers.h" // for sTimer
#include "GPIO.h"
struct sHeater {
uint8_t Pmin;
uint8_t Pmax;
uint16_t Fmin;
uint16_t Fmax;
uint8_t ThermostatMode;
uint8_t setTemperature;
uint8_t sysVoltage;
uint8_t fanSensor;
uint8_t glowDrive;
bool valid() {
bool retval = true;
retval &= Pmin < 100;
retval &= Pmax < 150;
retval &= Fmin < 5000;
retval &= Fmax < 6000;
retval &= ThermostatMode < 2;
retval &= setTemperature < 40;
retval &= sysVoltage == 120 || sysVoltage == 240;
retval &= fanSensor == 1 || fanSensor == 2;
retval &= glowDrive >= 1 && glowDrive <= 6;
return retval;
};
void init() {
Pmin = 14;
Pmax = 45;
Fmin = 1500;
Fmax = 4500;
ThermostatMode = 1;
setTemperature = 23;
sysVoltage = 120;
fanSensor = 1;
glowDrive = 5;
};
};
struct sHomeMenuActions {
uint8_t onTimeout;
uint8_t onStart;
uint8_t onStop;
bool valid() {
bool retval = true;
retval &= onTimeout < 4;
retval &= onStart < 4;
retval &= onStop < 4;
return retval;
}
void init() {
onTimeout = 0;
onStart = 0;
onStop = 0;
}
};
struct sBTCoptions {
long DimTime;
uint8_t degF;
uint8_t ThermostatMethod; // 0: standard heater, 1: Narrow Hysterisis, 2:Managed Hz mode
uint8_t enableWifi;
uint8_t enableOTA;
uint8_t cyclicMode;
uint8_t GPIOinMode;
uint8_t GPIOoutMode;
uint8_t GPIOalgMode;
uint16_t FrameRate;
sHomeMenuActions HomeMenu;
bool valid() {
bool retval = true;
retval &= (DimTime >= 0) && (DimTime < 300000); // 5 mins
retval &= (degF == 0) || (degF == 1);
retval &= (ThermostatMethod & 0x03) < 3; // only modes 0, 1 or 2
retval &= (enableWifi == 0) || (enableWifi == 1);
retval &= (enableOTA == 0) || (enableOTA == 1);
retval &= cyclicMode < 10;
retval &= GPIOinMode < 4;
retval &= GPIOoutMode < 3;
retval &= (FrameRate >= 300) && (FrameRate <= 1500);
retval &= HomeMenu.valid();
return retval;
}
void init() {
DimTime = 60000;
degF = 0;
ThermostatMethod = 0;
enableWifi = 1;
enableOTA = 1;
cyclicMode = 0;
GPIOinMode = 0;
GPIOoutMode = 0;
GPIOalgMode = 0;
FrameRate = 1000;
HomeMenu.init();
};
};
// the actual data stored to NV memory
struct sNVStore {
sHeater Heater;
sBTCoptions Options;
sTimer timer[14];
bool valid();
void init();
};
class CNVStorage {
public:
CNVStorage() {};
virtual ~CNVStorage() {};
virtual void init() = 0;
virtual void load() = 0;
virtual void save() = 0;
};
class CHeaterStorage : public CNVStorage {
protected:
sNVStore _calValues;
public:
CHeaterStorage();
virtual ~CHeaterStorage() {};
// TODO: These are only here to allow building without fully
// fleshing out NV storage for Due, Mega etc
// these should be removed once complete (pure virtual)
void init() {};
void load() {};
void save() {};
float getPmin();
float getPmax();
unsigned short getFmin();
unsigned short getFmax();
unsigned char getDesiredTemperature();
unsigned char getThermostatMode();
unsigned char getThermostatMethodMode();
float getThermostatMethodWindow();
unsigned char getSysVoltage();
unsigned char getFanSensor();
unsigned char getGlowDrive();
unsigned long getDimTime();
unsigned char getDegFMode();
unsigned char getWifiEnabled();
unsigned char getOTAEnabled();
unsigned char getCyclicMode();
GPIOinModes getGPIOinMode();
GPIOoutModes getGPIOoutMode();
GPIOalgModes getGPIOalgMode();
uint16_t getFrameRate();
const sHomeMenuActions& getHomeMenu() const;
void setPmin(float);
void setPmax(float);
void setFmin(unsigned short val);
void setFmax(unsigned short val);
void setDesiredTemperature(unsigned char val);
void setThermostatMode(unsigned char val);
void setThermostatMethodMode(unsigned char val);
void setThermostatMethodWindow(float val);
void setSystemVoltage(float fVal);
void setFanSensor(unsigned char val);
void setGlowDrive(unsigned char val);
void setDimTime(unsigned long val);
void setDegFMode(unsigned char val);
void setWifiEnabled(unsigned char val);
void setOTAEnabled(unsigned char val);
void setCyclicMode(unsigned char val);
void setGPIOinMode(unsigned char val);
void setGPIOoutMode(unsigned char val);
void setGPIOalgMode(unsigned char val);
void setFrameRate(uint16_t val);
void setHomeMenu(sHomeMenuActions val);
void getTimerInfo(int idx, sTimer& timerInfo);
void setTimerInfo(int idx, const sTimer& timerInfo);
};
#ifdef ESP32
#include <Preferences.h>
#include <functional>
class CESP32HeaterStorage : public CHeaterStorage {
Preferences preferences;
public:
CESP32HeaterStorage();
virtual ~CESP32HeaterStorage();
void init();
void load();
void save();
void loadHeater();
void saveHeater();
void loadTimer(int idx);
void saveTimer(int idx);
void loadUI();
void saveUI();
bool validatedLoad(const char* key, int8_t& val, int defVal, std::function<bool(int8_t, int8_t, int8_t)> validator, int min, int max);
bool validatedLoad(const char* key, uint8_t& val, int defVal, std::function<bool(uint8_t, uint8_t, uint8_t)> validator, int min, int max, uint8_t mask=0xff);
bool validatedLoad(const char* key, uint16_t& val, int defVal, std::function<bool(uint16_t, uint16_t, uint16_t)> validator, int min, int max);
bool validatedLoad(const char* key, long& val, long defVal, std::function<bool(long, long, long)> validator, long min, long max);
};
#endif
extern CHeaterStorage& NVstore;
#endif // __BTC_NV_STORAGE_H__