powersync-app/libnymea-app/energy/energylogs.h

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

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of libnymea-app.
*
* libnymea-app is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* libnymea-app is 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libnymea-app. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef ENERGYLOGS_H
#define ENERGYLOGS_H

#include "engine.h"

#include <QObject>
#include <QUuid>
#include <QQmlParserStatus>


class EnergyLogEntry: public QObject
{
    Q_OBJECT
    Q_PROPERTY(QDateTime timestamp READ timestamp CONSTANT)
public:
    EnergyLogEntry(QObject *parent = nullptr);
    EnergyLogEntry(const QDateTime &timestamp, QObject *parent = nullptr);

    QDateTime timestamp() const;
private:
    QDateTime m_timestamp;

};

class EnergyLogs : public QAbstractListModel, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)
    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
    Q_PROPERTY(Engine *engine READ engine WRITE setEngine NOTIFY engineChanged)
    Q_PROPERTY(SampleRate sampleRate READ sampleRate WRITE setSampleRate NOTIFY sampleRateChanged)
    Q_PROPERTY(QDateTime startTime READ startTime WRITE setStartTime NOTIFY startTimeChanged)
    Q_PROPERTY(QDateTime endTime READ endTime WRITE setEndTime NOTIFY endTimeChanged)
    Q_PROPERTY(bool live READ live WRITE setLive NOTIFY liveChanged)
    Q_PROPERTY(bool fetchingData READ fetchingData NOTIFY fetchingDataChanged)
    Q_PROPERTY(bool loadingInhibited READ loadingInhibited WRITE setLoadingInhibited NOTIFY loadingInhibitedChanged)
    Q_PROPERTY(double minValue READ minValue NOTIFY minValueChanged)
    Q_PROPERTY(double maxValue READ maxValue NOTIFY maxValueChanged)

    friend class ThingPowerLogs;

public:
    enum SampleRate {
        SampleRate1Min = 1,
        SampleRate15Mins = 15,
        SampleRate1Hour = 60,
        SampleRate3Hours = 180,
        SampleRate1Day = 1440,
        SampleRate1Week = 10080,
        SampleRate1Month = 43200,
        SampleRate1Year = 525600
    };
    Q_ENUM(SampleRate)

    explicit EnergyLogs(QObject *parent = nullptr);
    virtual ~EnergyLogs();

    Engine *engine() const;
    void setEngine(Engine *engine);

    SampleRate sampleRate() const;
    void setSampleRate(SampleRate sampleRate);

    QDateTime startTime() const;
    void setStartTime(const QDateTime &startTime);

    QDateTime endTime() const;
    void setEndTime(const QDateTime &endTime);

    bool live() const;
    void setLive(bool live);

    bool fetchingData() const;

    bool loadingInhibited() const;
    void setLoadingInhibited(bool loadingInhibited);

    void classBegin() override;
    void componentComplete() override;

    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    QVariant data(const QModelIndex &index, int role) const override;

    double minValue() const;
    double maxValue() const;

    Q_INVOKABLE EnergyLogEntry* get(int index) const;
    Q_INVOKABLE int indexOf(const QDateTime &timestamp);
    Q_INVOKABLE EnergyLogEntry* find(const QDateTime &timestamp);
    Q_INVOKABLE QList<EnergyLogEntry*> entries() const;

public slots:
    void clear();
    void fetchLogs();

signals:
    void engineChanged();
    void sampleRateChanged();
    void startTimeChanged();
    void endTimeChanged();
    void liveChanged();
    void fetchingDataChanged();
    void loadingInhibitedChanged();

    void countChanged();
    void entryAdded(int index, EnergyLogEntry *entry);
    void entriesAdded(int index, const QList<EnergyLogEntry*> &entries);
    void entriesAddedIdx(int index, int count);
    void entriesRemoved(int index, int count);

    void minValueChanged();
    void maxValueChanged();

protected:
    virtual QString logsName() const = 0;
    virtual QVariantMap fetchParams() const;
    virtual QList<EnergyLogEntry*> unpackEntries(const QVariantMap &params, double *minValue, double *maxValue) = 0;
    virtual void notificationReceived(const QVariantMap &data) = 0;

    void appendEntry(EnergyLogEntry *entry, double minValue, double maxValue);
    void appendEntries(const QList<EnergyLogEntry *> &entries);

protected slots:
    void getLogsResponse(int commandId, const QVariantMap &params);
    void notificationReceivedInternal(const QVariantMap &data);

private:
    Engine *m_engine = nullptr;
    SampleRate m_sampleRate = SampleRate15Mins;
    bool m_fetchPowerBalance = true;
    QDateTime m_startTime;
    QDateTime m_endTime;
    bool m_live = true;
    bool m_fetchingData = false;
    bool m_loadingInhibited = false;
    bool m_ready = false;
    bool m_fetchAgain = false;

    double m_minValue = 0;
    double m_maxValue = 0;

    QList<EnergyLogEntry*> m_list;
};

#endif // ENERGYLOGS_H