// 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 ILOADAPTER_H
#define ILOADAPTER_H

#include <QObject>
#include <QString>

#include <integrations/thing.h>

#include "types/loadrole.h"

// Abstract interface for all load adapters.
//
// Each adapter wraps a nymea Thing and knows how to:
//  - Apply a target power setpoint (applyPower)
//  - Test the physical connection (testConnection)
//  - Report current power draw and reachability
//
// Adapters are created by LoadAdapterRegistry based on the detected adapter type
// for a given role + Thing combination.
class ILoadAdapter : public QObject
{
    Q_OBJECT
public:
    explicit ILoadAdapter(QObject *parent = nullptr) : QObject(parent) {}
    virtual ~ILoadAdapter() = default;

    // Unique adapter type identifier (e.g. "relay", "sgready", "evcharger", "battery")
    virtual QString  adapterId()     const = 0;

    // Role this adapter serves
    virtual LoadRole role()          const = 0;

    // Underlying nymea ThingId
    virtual ThingId  thingId()       const = 0;

    // Apply a target power setpoint in watts.
    //  > 0  → charge/heat at this power
    //  = 0  → stop / standby
    //  < 0  → discharge (batteries only)
    virtual void applyPower(double targetPowerW) = 0;

    // Initiate a connection test. Result is delivered via testResult() signal.
    virtual void testConnection() = 0;

    // Current reported power draw in watts (from Thing state, may be 0 if not metered).
    virtual double currentPowerW() const = 0;

    // Whether the underlying Thing is currently reachable.
    virtual bool isReachable() const = 0;

signals:
    // Emitted after testConnection() completes.
    void testResult(bool success, const QString &message);

    // Emitted after applyPower() completes.
    void powerApplied(double powerW, bool success);

    // Emitted when the reachability of the underlying Thing changes.
    void reachabilityChanged(bool reachable);
};

#endif // ILOADAPTER_H