control_engine.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>
 
struct ControlConfig {
  float defaultTargetTemperatureC;     
  float minimumTargetTemperatureC;     
  float maximumTargetTemperatureC;     
  uint8_t fallbackPwmPercent;          
  float minimumCoolingOnDeltaC;        
  float maximumCoolingOnDeltaC;        
  float coolingOnDeltaC;               
  float minimumCoolingOffDeltaC;       
  float maximumCoolingOffDeltaC;       
  float coolingOffDeltaC;              
  float minimumHighCoolingDeltaC;      
  float maximumHighCoolingDeltaC;      
  float highCoolingDeltaC;             
  uint8_t minimumFanLowPwmPercent;     
  uint8_t maximumFanLowPwmPercent;     
  uint8_t fanLowPwmPercent;            
  uint8_t minimumFanHighPwmPercent;    
  uint8_t maximumFanHighPwmPercent;    
  uint8_t fanHighPwmPercent;           
};
 
enum class ControlMode : uint8_t {
  kFanOff,                
  kFanLow,                
  kFanHigh,               
  kWaterSensorFallback,   
};
 
struct ControlInputs {
  bool hasConfiguredTargetTemperature; 
  float requestedTargetTemperatureC;   
  bool waterSensorValid;               
  float waterTemperatureC;             
  ControlMode previousMode;            
};
 
struct ControlSnapshot {
  float targetTemperatureC;       
  bool targetDefaulted;           
  bool waterSensorValid;          
  float waterTemperatureC;        
  float waterDeltaC;              
  uint8_t waterBasedPwmPercent;   
  uint8_t finalPwmPercent;        
  ControlMode mode;               
};
 
constexpr ControlConfig kDefaultControlConfig = {
    23.0f,
    15.0f,
    35.0f,
    40,
    0.1f,
    3.0f,
    0.5f,
    -3.0f,
    -0.1f,
    -0.5f,
    0.2f,
    5.0f,
    1.0f,
    15,
    60,
    45,
    20,
    100,
    60,
};
 
namespace ControlEngine {
 
bool isTargetTemperatureValid(float targetTemperatureC,
                              const ControlConfig& config = kDefaultControlConfig);
 
bool isControlConfigValid(const ControlConfig& config);
 
float sanitizeTargetTemperature(float targetTemperatureC,
                                const ControlConfig& config = kDefaultControlConfig);
 
ControlSnapshot compute(const ControlInputs& inputs,
                        const ControlConfig& config = kDefaultControlConfig);
 
const char* modeLabel(ControlMode mode);
 
}  // namespace ControlEngine