// SPDX-License-Identifier: GPL-3.0-or-later

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of nymea-energy-plugin-nymea.
*
* nymea-energy-plugin-nymea.s 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.
*
* nymea-energy-plugin-nymea.s 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 nymea-energy-plugin-nymea. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef SGREADYADAPTER_H
#define SGREADYADAPTER_H

#include "adapters/iloadapter.h"

#include <integrations/thingmanager.h>

// SG-Ready adapter for heat pumps controlled via two relay contacts.
//
// SG-Ready uses 2 binary relay contacts to select operating mode:
//   SG1 (blocked):  relay1=OFF, relay2=OFF  — forced off
//   SG2 (normal):   relay1=OFF, relay2=ON   — normal operation
//   SG3 (surplus):  relay1=ON,  relay2=OFF  — raise setpoint (surplus mode)
//   SG4 (boost):    relay1=ON,  relay2=ON   — forced max heat
//
// Power mapping:
//   applyPower(0)              → SG1 (blocked)
//   applyPower(<normalPowerW)  → SG2 (normal)
//   applyPower(normalPowerW)   → SG3 (surplus)
//   applyPower(>normalPowerW)  → SG4 (boost)
class SgReadyAdapter : public ILoadAdapter
{
    Q_OBJECT
public:
    explicit SgReadyAdapter(ThingManager *thingManager,
                            const ThingId &relay1ThingId,
                            const ThingId &relay2ThingId,
                            double normalPowerW = 1500.0,
                            QObject *parent = nullptr);

    QString  adapterId()     const override;
    LoadRole role()          const override;
    ThingId  thingId()       const override; // returns relay1 ThingId
    void     applyPower(double targetPowerW) override;
    void     testConnection()               override;
    double   currentPowerW()                const override;
    bool     isReachable()                  const override;

private:
    enum class SgMode { SG1_Blocked, SG2_Normal, SG3_Surplus, SG4_Boost };
    void applyMode(SgMode mode);
    void setRelayPower(Thing *thing, bool on);

    ThingManager *m_thingManager  = nullptr;
    Thing        *m_relay1        = nullptr;
    Thing        *m_relay2        = nullptr;
    double        m_normalPowerW;
    SgMode        m_currentMode   = SgMode::SG2_Normal;
};

#endif // SGREADYADAPTER_H