app_state_model.hpp

Go to the documentation of this file.

 
#ifndef APP_STATE_MODEL__
#define APP_STATE_MODEL__
 
#include <ArduinoJson.h>
 
#include "ps_pwm.h"
 
#include "app_config.hpp"
 
 
/***************** AuxHwDrv state with initial values ******************/
struct AuxHwDrvState
{
    float current_limit = 8.0f;
    bool relay_ref_active = false;
    bool relay_dut_active = false;
    float temp_1 = 150.0f;
    float temp_2 = 150.0f;
    float temp_1_limit = 50.0f;
    float temp_2_limit = 50.0f;
    bool fan_active = true;
    // Manual override, fan is permanently "on" when true
    bool fan_override = false;
    bool drv_supply_active = true;
    bool drv_disabled = false;
    // Overtemperature shutdown active flag
    bool hw_overtemp = true;
};
 
 
struct AppState
{
    //
    // ATTENTION!
    // Following constants need to be adapted if JSON object size is changed!
    static constexpr size_t _key_strings_size = sizeof(
        "setpoint_throttling_enabled"
        "base_div"
        "timer_div"
        "frequency_min_hw"
        "frequency_max_hw"
        "frequency_min"
        "frequency_max"
        "frequency"
        "frequency_changerate"
        "duty_min"
        "duty_max"
        "duty"
        "duty_changerate"
        "dt_sum_max_hw"
        "lead_dt"
        "lag_dt"
        "current_limit"
        "temp_1_limit"
        "temp_2_limit"
        "temp_1"
        "temp_2"
        "fan_active"
        "fan_override"
        "relay_ref_active"
        "relay_dut_active"
        "drv_supply_active"
        "drv_disabled"
        "power_pwm_active"
        "hw_oc_fault"
        "hw_overtemp"
        "oneshot_len"
        );
    // JSON_OBJECT_SIZE is provided with the number of properties as from above
    static constexpr size_t _json_objects_size = JSON_OBJECT_SIZE(31);
    // Prevent buffer overflow even if above calculations are wrong...
    static constexpr size_t I_AM_SCARED_MARGIN = 50;
    static constexpr size_t json_buf_len = _json_objects_size
                                            + _key_strings_size
                                            + I_AM_SCARED_MARGIN;
 
    // Initial values for AppController()
    static constexpr AppConstants constants{};
 
 
    // WiFi network configuration
    NetworkConfig net_conf{};
 
    // State from AuxHwDrv module
    AuxHwDrvState *aux_hw_drv_state = nullptr;
 
    // Setpoint throttling (rate of change limiting) takes place when enabled
    bool setpoint_throttling_enabled = true;
    // Internal setpoints of PSPWM C API
    pspwm_clk_conf_t* pspwm_clk_conf = nullptr;
    pspwm_setpoint_t* pspwm_setpoint = nullptr;
    pspwm_setpoint_limits_t* pspwm_setpoint_limits = nullptr;
    // Runtime user setpoint limits
    float frequency_min = constants.frequency_min;
    float frequency_max = constants.frequency_max;
    // Runtime setpoints and throttling increment per fast event timer interval
    float frequency_target = 100.0e3f;
    float frequency_increment = 500.0f;
    float duty_min = 0.0f;
    float duty_max = 0.8f;
    float duty_target = 0.0f;
    float duty_increment = 0.05f;
    // True when hardware OC shutdown condition is currently present
    bool hw_oc_fault_present = true;
    // Hardware Overcurrent Fault Shutdown Status is latched using this flag
    bool hw_oc_fault_occurred = true;
    // Pulse length for one-shot mode power output pulse
    uint32_t oneshot_power_pulse_length_ms = 1;
 
 
     size_t serialize_full_state(char *buf, size_t buf_len);
 
    bool deserialize_settings(const char *buf, size_t buf_len);
 
    bool save_to_file(const char *filename);
 
    bool restore_from_file(const char *filename);
};
 
#endif