mhi_ac_ctrl.h

#include "MHI-AC-Ctrl-core.h"
#define ROOM_TEMP_MQTT 1
#include <vector>
#include <string>

static const std::vector<std::string> protection_states = {
    "Normal",
    "Discharge pipe temperature protection control",
    "Discharge pipe temperature anomaly",
    "Current safe control of inverter primary current",
    "High pressure protection control",
    "High pressure anomaly",
    "Low pressure protection control",
    "Low pressure anomaly",
    "Anti-frost prevention control",
    "Current cut",
    "Power transistor protection control",
    "Power transistor anomaly (Overheat)",
    "Compression ratio control",
    "-",
    "Condensation prevention control",
    "Current safe control of inverter secondary current",
    "Stop by compressor rotor lock",
    "Stop by compressor startup failure"
};

static const char* TAG = "mhi_ac_ctrl";

unsigned long room_temp_api_timeout_ms = millis();

class MhiAcCtrl : public climate::Climate,
                  public Component,
                  public CallbackInterface_Status {
public:
    void setup() override
    {
        this->power_ = power_off;
        this->current_temperature = NAN;
        // restore set points
        auto restore = this->restore_state_();
        if (restore.has_value()) {
            restore->apply(this);
        } else {
            // restore from defaults
            this->mode = climate::CLIMATE_MODE_OFF;
            // initialize target temperature to some value so that it's not NAN
            this->target_temperature = roundf(clamp(
                this->current_temperature, this->minimum_temperature_, this->maximum_temperature_));
            this->fan_mode = climate::CLIMATE_FAN_AUTO;
            this->swing_mode = climate::CLIMATE_SWING_OFF;
        }
        // Never send nan to HA
        if (isnan(this->target_temperature))
            this->target_temperature = 20;

        error_code_.set_icon("mdi:alert-circle");

        outdoor_temperature_.set_icon("mdi:thermometer");
        outdoor_temperature_.set_unit_of_measurement("°C");
        outdoor_temperature_.set_accuracy_decimals(2);

        return_air_temperature_.set_icon("mdi:thermometer");
        return_air_temperature_.set_unit_of_measurement("°C");
        return_air_temperature_.set_accuracy_decimals(2);

        outdoor_unit_fan_speed_.set_icon("mdi:fan");

        indoor_unit_fan_speed_.set_icon("mdi:fan");

        compressor_frequency_.set_icon("mdi:sine-wave");
        compressor_frequency_.set_unit_of_measurement("Hz");
        compressor_frequency_.set_accuracy_decimals(1);

        indoor_unit_total_run_time_.set_icon("mdi:clock");
        indoor_unit_total_run_time_.set_unit_of_measurement("h");

        compressor_total_run_time_.set_icon("mdi:clock");
        compressor_total_run_time_.set_unit_of_measurement("h");

        current_power_.set_icon("mdi:current-ac");
        current_power_.set_unit_of_measurement("A");
        current_power_.set_accuracy_decimals(2);

        defrost_.set_icon("mdi:snowflake-melt");

        vanes_pos_.set_icon("mdi:air-filter");

        indoor_unit_thi_r1_.set_icon("mdi:thermometer");
        indoor_unit_thi_r1_.set_unit_of_measurement("°C");
        indoor_unit_thi_r1_.set_accuracy_decimals(2);

        indoor_unit_thi_r2_.set_icon("mdi:thermometer");
        indoor_unit_thi_r2_.set_unit_of_measurement("°C");
        indoor_unit_thi_r2_.set_accuracy_decimals(2);

        indoor_unit_thi_r3_.set_icon("mdi:thermometer");
        indoor_unit_thi_r3_.set_unit_of_measurement("°C");
        indoor_unit_thi_r3_.set_accuracy_decimals(2);

        outdoor_unit_tho_r1_.set_icon("mdi:thermometer");
        outdoor_unit_tho_r1_.set_unit_of_measurement("°C");
        outdoor_unit_tho_r1_.set_accuracy_decimals(2);

        outdoor_unit_expansion_valve_.set_icon("mdi:valve");
        outdoor_unit_expansion_valve_.set_unit_of_measurement("pulse");
        outdoor_unit_expansion_valve_.set_accuracy_decimals(0);

        outdoor_unit_discharge_pipe_.set_icon("mdi:thermometer");
        outdoor_unit_discharge_pipe_.set_unit_of_measurement("°C");
        outdoor_unit_discharge_pipe_.set_accuracy_decimals(1);

        outdoor_unit_discharge_pipe_super_heat_.set_icon("mdi:thermometer");
        outdoor_unit_discharge_pipe_super_heat_.set_unit_of_measurement("°C");
        outdoor_unit_discharge_pipe_super_heat_.set_accuracy_decimals(1);

        protection_state_.set_icon("mdi:shield-alert-outline");

        protection_state_number_.set_icon("mdi:shield-alert-outline");

        energy_used_.set_icon("mdi:lightning-bolt");
        energy_used_.set_unit_of_measurement("kWh");
        energy_used_.set_accuracy_decimals(2);

        mhi_ac_ctrl_core.MHIAcCtrlStatus(this);
        mhi_ac_ctrl_core.init();
    }

    void loop() override
    {
        if(millis() - room_temp_api_timeout_ms >= id(room_temp_api_timeout)*1000) {
            mhi_ac_ctrl_core.set_troom(0xff);  // use IU temperature sensor
            room_temp_api_timeout_ms = millis();
            ESP_LOGD("mhi_ac_ctrl", "did not receive a room_temp_api value, using IU temperature sensor");
        }

        int ret = mhi_ac_ctrl_core.loop(100);
        if (ret < 0)
            ESP_LOGW("mhi_ac_ctrl", "mhi_ac_ctrl_core.loop error: %i", ret);
    }

    void dump_config() override
    {
        LOG_CLIMATE("", "MHI-AC-Ctrl Climate", this);
        ESP_LOGCONFIG(TAG, "  Min. Temperature: %.1f°C", this->minimum_temperature_);
        ESP_LOGCONFIG(TAG, "  Max. Temperature: %.1f°C", this->maximum_temperature_);
        ESP_LOGCONFIG(TAG, "  Supports HEAT: %s", YESNO(true));
        ESP_LOGCONFIG(TAG, "  Supports COOL: %s", YESNO(true));
    }

    void cbiStatusFunction(ACStatus status, int value) override
    {
        static int mode_tmp = 0xff;
        ESP_LOGD("mhi_ac_ctrl", "received status=%i value=%i power=%i", status, value, this->power_);

        if (this->power_ == power_off) {
            // Workaround for status after reboot
            this->mode = climate::CLIMATE_MODE_OFF;
            this->publish_state();
        }

        switch (status) {
        case status_power:
            if (value == power_on) {
                this->power_ = power_on;
                // output_P(status, (TOPIC_POWER), PSTR(PAYLOAD_POWER_ON));
                cbiStatusFunction(status_mode, mode_tmp);
            } else {
                // output_P(status, (TOPIC_POWER), (PAYLOAD_POWER_OFF));
                // output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_OFF));
                this->power_ = power_off;
                this->mode = climate::CLIMATE_MODE_OFF;
                this->publish_state();
            }
            break;
        case status_mode:
            mode_tmp = value;
        case opdata_mode:
        case erropdata_mode:
            switch (value) {
            case mode_auto:
                // if (status != erropdata_mode)
                //    output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_AUTO));
                // else
                //    output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_STOP));
                //    break;
                if (status != erropdata_mode && this->power_ > 0) {
                    this->mode = climate::CLIMATE_MODE_HEAT_COOL;
                } else {
                    this->mode = climate::CLIMATE_MODE_OFF;
                }
                break;
            case mode_dry:
                // output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_DRY));
                this->mode = climate::CLIMATE_MODE_DRY;
                break;
            case mode_cool:
                // output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_COOL));
                this->mode = climate::CLIMATE_MODE_COOL;
                break;
            case mode_fan:
                // output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_FAN));
                this->mode = climate::CLIMATE_MODE_FAN_ONLY;
                break;
            case mode_heat:
                // output_P(status, PSTR(TOPIC_MODE), PSTR(PAYLOAD_MODE_HEAT));
                this->mode = climate::CLIMATE_MODE_HEAT;
                break;
            default:
                ESP_LOGD("mhi_ac_ctrl", "unknown status mode value %i", value);
            }
            this->publish_state();
            break;
        case status_fan:
            switch (value) {
            case 0:
                this->fan_mode = climate::CLIMATE_FAN_LOW;
                break;
            case 1:
                this->fan_mode = climate::CLIMATE_FAN_MEDIUM;
                break;
            case 2:
                this->fan_mode = climate::CLIMATE_FAN_HIGH;
                break;
            case 6:
                this->fan_mode = climate::CLIMATE_FAN_DIFFUSE;
                break;
            case 7:
                this->fan_mode = climate::CLIMATE_FAN_AUTO;
                break;
            }
            this->publish_state();
            break;
        case status_vanes:
            switch (value) {
            case vanes_unknown:
                this->swing_mode = climate::CLIMATE_SWING_OFF;
                break;
            case vanes_1:
                this->swing_mode = climate::CLIMATE_SWING_HORIZONTAL;
                break;
            case vanes_2:
                this->swing_mode = climate::CLIMATE_SWING_HORIZONTAL;
                break;
            case vanes_3:
                this->swing_mode = climate::CLIMATE_SWING_OFF;
                break;
            case vanes_4:
                this->swing_mode = climate::CLIMATE_SWING_VERTICAL;
                break;
            case vanes_swing:
                this->swing_mode = climate::CLIMATE_SWING_BOTH;
                break;
            }
            this->publish_state();
            break;
        case status_troom:
            // dtostrf((value - 61) / 4.0, 0, 2, strtmp);
            // output_P(status, PSTR(TOPIC_TROOM), strtmp);
            this->current_temperature = (value - 61) / 4.0;
            this->publish_state();
            break;
        case status_tsetpoint:
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_TSETPOINT), strtmp);
            this->target_temperature = (value & 0x7f)/ 2.0;
            this->publish_state();
            break;
        case status_errorcode:
        case erropdata_errorcode:
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_ERRORCODE), strtmp);
            error_code_.publish_state(value);
            break;
        case opdata_return_air:
        case erropdata_return_air:
            // dtostrf(value * 0.25f - 15, 0, 2, strtmp);
            // output_P(status, PSTR(TOPIC_RETURNAIR), strtmp);
            return_air_temperature_.publish_state(value * 0.25f - 15);
            break;
        case opdata_thi_r1:
            // Indoor Heat exchanger temperature 1 (U-bend)
           indoor_unit_thi_r1_.publish_state(0.327f * value - 11.4f);
           break;
        case erropdata_thi_r1:
            // itoa(0.327f * value - 11.4f, strtmp, 10); // only rough approximation
            // output_P(status, PSTR(TOPIC_THI_R1), strtmp);
            break;
        case opdata_thi_r2:
            // Indoor Heat exchanger temperature 2 (capillary)
            indoor_unit_thi_r2_.publish_state(0.327f * value - 11.4f);
            break;
        case erropdata_thi_r2:
            // itoa(0.327f * value - 11.4f, strtmp, 10); // formula for calculation not known
            // output_P(status, PSTR(TOPIC_THI_R2), strtmp);
            break;
        case opdata_thi_r3:
            // Indoor Heat exchanger temperature 3 (suction header)
            indoor_unit_thi_r3_.publish_state(0.327f * value - 11.4f);
            break;
        case erropdata_thi_r3:
            // itoa(0.327f * value - 11.4f, strtmp, 10); // only rough approximation
            // output_P(status, PSTR(TOPIC_THI_R3), strtmp);
            break;
        case opdata_iu_fanspeed:
        case erropdata_iu_fanspeed:
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_IU_FANSPEED), strtmp);
            indoor_unit_fan_speed_.publish_state(value);
            break;
        case opdata_total_iu_run:
        case erropdata_total_iu_run:
            // itoa(value * 100, strtmp, 10);
            // output_P(status, PSTR(TOPIC_TOTAL_IU_RUN), strtmp);
            indoor_unit_total_run_time_.publish_state(value * 100);
            break;
        case erropdata_outdoor:
        case opdata_outdoor:
            // dtostrf((value - 94) * 0.25f, 0, 2, strtmp);
            // output_P(status, PSTR(TOPIC_OUTDOOR), strtmp);
            outdoor_temperature_.publish_state((value - 94) * 0.25f);
            break;
        case opdata_tho_r1:
            // Indoor Heat exchanger temperature 3 (suction header)
            outdoor_unit_tho_r1_.publish_state(0.327f * value - 11.4f);
            break;
        case erropdata_tho_r1:
            // itoa(0.327f * value - 11.4f, strtmp, 10); // formula for calculation not known
            // output_P(status, PSTR(TOPIC_THO_R1), strtmp);
            break;
        case opdata_comp:
        case erropdata_comp:
            // dtostrf(
            //    highByte(value) * 25.6f + 0.1f * lowByte(value), 0, 2, strtmp); // to be confirmed
            // output_P(status, PSTR(TOPIC_COMP), strtmp);
            compressor_frequency_.publish_state(highByte(value) * 25.6f + 0.1f * lowByte(value));
            break;
        case erropdata_td:
        case opdata_td:
            if (value < 0x2)
                outdoor_unit_discharge_pipe_.publish_state(30);
            else
                outdoor_unit_discharge_pipe_.publish_state(value / 2 + 32);
            break;
        case opdata_ct:
        case erropdata_ct:
            // dtostrf(value * 14 / 51.0f, 0, 2, strtmp);
            // output_P(status, PSTR(TOPIC_CT), strtmp);
            current_power_.publish_state(value * 14 / 51.0f);
            break;
        case opdata_tdsh:
            outdoor_unit_discharge_pipe_super_heat_.publish_state(value);
            // itoa(value, strtmp, 10); // formula for calculation not known
            // output_P(status, PSTR(TOPIC_TDSH), strtmp);
            break;
        case opdata_protection_no:
            if (value < protection_states.size())
                protection_state_.publish_state(protection_states[value]);
            protection_state_number_.publish_state(value);
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_PROTECTION_NO), strtmp);
            break;
        case opdata_ou_fanspeed:
        case erropdata_ou_fanspeed:
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_OU_FANSPEED), strtmp);
            outdoor_unit_fan_speed_.publish_state(value);
            break;
        case opdata_defrost:
            // if (value)
            //     output_P(status, PSTR(TOPIC_DEFROST), PSTR(PAYLOAD_OP_DEFROST_ON));
            // else
            //     output_P(status, PSTR(TOPIC_DEFROST), PSTR(PAYLOAD_OP_DEFROST_OFF));
            defrost_.publish_state(value != 0);
            break;
        case opdata_total_comp_run:
        case erropdata_total_comp_run:
            // itoa(value * 100, strtmp, 10);
            // output_P(status, PSTR(TOPIC_TOTAL_COMP_RUN), strtmp);
            compressor_total_run_time_.publish_state(value * 100);
            break;
        case opdata_ou_eev1:
            outdoor_unit_expansion_valve_.publish_state(value);
            break;
        case erropdata_ou_eev1:
            // itoa(value, strtmp, 10);
            // output_P(status, PSTR(TOPIC_OU_EEV1), strtmp);
            break;
        case opdata_tsetpoint:
        case erropdata_tsetpoint:
            break;
        case opdata_kwh:
            // https://github.com/absalom-muc/MHI-AC-Ctrl/pull/135
            // This item is counting the kWh from the point where the AC is powered On
            energy_used_.publish_state(value * 0.25);
            break;
        case opdata_unknown:
            // skip these values as they are not used currently
            break;
        }
    }

    std::vector<Sensor *> get_sensors() {
        return {
            &error_code_,
            &outdoor_temperature_,
            &return_air_temperature_,
            &outdoor_unit_fan_speed_,
            &indoor_unit_fan_speed_,
            &current_power_,
            &compressor_frequency_,
            &indoor_unit_total_run_time_,
            &compressor_total_run_time_,
            &vanes_pos_,
            &energy_used_,
            &indoor_unit_thi_r1_,
            &indoor_unit_thi_r2_,
            &indoor_unit_thi_r3_,
            &outdoor_unit_tho_r1_,
            &outdoor_unit_expansion_valve_,
            &outdoor_unit_discharge_pipe_,
            &outdoor_unit_discharge_pipe_super_heat_,
            &protection_state_number_
        };
    }

    std::vector<TextSensor *> get_text_sensors() {
        return { &protection_state_ };
    }

    std::vector<BinarySensor *> get_binary_sensors() {
        return { &defrost_ };
    }

    void set_room_temperature(float value) {
        if ((value > -10) & (value < 48)) {
            room_temp_api_timeout_ms = millis();  // reset timeout
            byte tmp = value*4+61;
            mhi_ac_ctrl_core.set_troom(value*4+61);
            ESP_LOGD("mhi_ac_ctrl", "set room_temp_api: %f %i %i", value, (byte)(value*4+61), (byte)tmp);
        }
    }

    void set_vanes(int value) {
        mhi_ac_ctrl_core.set_vanes(value);
        ESP_LOGD("mhi_ac_ctrl", "set vanes: %i", value);
    }

protected:
    /// Transmit the state of this climate controller.
    void control(const climate::ClimateCall& call) override
    {
        if (call.get_mode().has_value()) {
            this->mode = *call.get_mode();

            power_ = power_on;
            switch (this->mode) {
            case climate::CLIMATE_MODE_OFF:
                power_ = power_off;
                break;
            case climate::CLIMATE_MODE_COOL:
                mode_ = mode_cool;
                break;
            case climate::CLIMATE_MODE_HEAT:
                mode_ = mode_heat;
                break;
            case climate::CLIMATE_MODE_DRY:
                mode_ = mode_dry;
                break;
            case climate::CLIMATE_MODE_FAN_ONLY:
                mode_ = mode_fan;
                break;
            case climate::CLIMATE_MODE_HEAT_COOL:
            default:
                mode_ = mode_auto;
                break;
            }

            mhi_ac_ctrl_core.set_power(power_);
            mhi_ac_ctrl_core.set_mode(mode_);
        }

        if (call.get_target_temperature().has_value()) {
            this->target_temperature = *call.get_target_temperature();

            tsetpoint_ = clamp(this->target_temperature, minimum_temperature_, maximum_temperature_);

            mhi_ac_ctrl_core.set_tsetpoint((byte)(2 * tsetpoint_));
        }

        if (call.get_fan_mode().has_value()) {
            this->fan_mode = *call.get_fan_mode();

            switch (*this->fan_mode) {
            case climate::CLIMATE_FAN_LOW:
                fan_ = 0;
                break;
            case climate::CLIMATE_FAN_MEDIUM:
                fan_ = 1;
                break;
            case climate::CLIMATE_FAN_HIGH:
                fan_ = 2;
                break;
            case climate::CLIMATE_FAN_DIFFUSE:
                fan_ = 6;
                break;
            case climate::CLIMATE_FAN_AUTO:
            default:
                fan_ = 7;
                break;
            }

            mhi_ac_ctrl_core.set_fan(fan_);
        }

        if (call.get_swing_mode().has_value()) {
            this->swing_mode = *call.get_swing_mode();

            switch (this->swing_mode) {
            case climate::CLIMATE_SWING_BOTH:
                vanes_ = vanes_swing;
                break;
            case climate::CLIMATE_SWING_VERTICAL:
                vanes_ = vanes_4;
                break;
            case climate::CLIMATE_SWING_HORIZONTAL:
                vanes_ = vanes_1;
                break;
            default:
            case climate::CLIMATE_SWING_OFF:
                vanes_ = vanes_3;
                break;
            }
            
            mhi_ac_ctrl_core.set_vanes(vanes_);
        }

        this->publish_state();
    }

    /// Return the traits of this controller.
    climate::ClimateTraits traits() override
    {
        auto traits = climate::ClimateTraits();
        traits.set_supports_current_temperature(true);
        traits.set_supported_modes({ CLIMATE_MODE_OFF, CLIMATE_MODE_HEAT_COOL, CLIMATE_MODE_COOL, CLIMATE_MODE_HEAT, CLIMATE_MODE_DRY, CLIMATE_MODE_FAN_ONLY });
        traits.set_supports_two_point_target_temperature(false);
        traits.set_visual_min_temperature(this->minimum_temperature_);
        traits.set_visual_max_temperature(this->maximum_temperature_);
        traits.set_visual_temperature_step(this->temperature_step_);
        traits.set_supported_fan_modes({ CLIMATE_FAN_AUTO, CLIMATE_FAN_LOW, CLIMATE_FAN_MEDIUM, CLIMATE_FAN_HIGH, CLIMATE_FAN_DIFFUSE });
        traits.set_supported_swing_modes({ CLIMATE_SWING_OFF, CLIMATE_SWING_BOTH, CLIMATE_SWING_VERTICAL, CLIMATE_SWING_HORIZONTAL });
        return traits;
    }

    float minimum_temperature_ { 18.0f };
    float maximum_temperature_ { 30.0f };
    float temperature_step_ { 0.5f };

    ACPower power_;
    ACMode mode_;
    float tsetpoint_;
    uint fan_;
    ACVanes vanes_;

    MHI_AC_Ctrl_Core mhi_ac_ctrl_core;

    Sensor error_code_;
    Sensor outdoor_temperature_;
    Sensor return_air_temperature_;
    Sensor outdoor_unit_fan_speed_;
    Sensor indoor_unit_fan_speed_;
    Sensor compressor_frequency_;
    Sensor indoor_unit_total_run_time_;
    Sensor compressor_total_run_time_;
    Sensor current_power_;
    BinarySensor defrost_;
    Sensor vanes_pos_;
    Sensor energy_used_;
    Sensor indoor_unit_thi_r1_;
    Sensor indoor_unit_thi_r2_;
    Sensor indoor_unit_thi_r3_;
    Sensor outdoor_unit_tho_r1_;
    Sensor outdoor_unit_expansion_valve_;
    Sensor outdoor_unit_discharge_pipe_;
    Sensor outdoor_unit_discharge_pipe_super_heat_;
    Sensor protection_state_number_;
    TextSensor protection_state_;
};