frontend/battery.h

/*
    SPDX-FileCopyrightText: 2006-2007 Kevin Ottens <[email protected]>
    SPDX-FileCopyrightText: 2012 Lukas Tinkl <[email protected]>
    SPDX-FileCopyrightText: 2014 Kai Uwe Broulik <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/

#ifndef SOLID_BATTERY_H
#define SOLID_BATTERY_H

#include <solid/solid_export.h>

#include <solid/deviceinterface.h>

namespace Solid
{
class BatteryPrivate;
class Device;

class SOLID_EXPORT Battery : public DeviceInterface
{
    Q_OBJECT
    Q_PROPERTY(bool present READ isPresent NOTIFY presentStateChanged)
    Q_PROPERTY(BatteryType type READ type CONSTANT)
    Q_PROPERTY(int chargePercent READ chargePercent NOTIFY chargePercentChanged)
    Q_PROPERTY(int capacity READ capacity NOTIFY capacityChanged)
    Q_PROPERTY(bool rechargeable READ isRechargeable CONSTANT)
    Q_PROPERTY(bool powerSupply READ isPowerSupply NOTIFY powerSupplyStateChanged)
    Q_PROPERTY(ChargeState chargeState READ chargeState NOTIFY chargeStateChanged)
    Q_PROPERTY(qlonglong timeToEmpty READ timeToEmpty NOTIFY timeToEmptyChanged)
    Q_PROPERTY(qlonglong timeToFull READ timeToFull NOTIFY timeToFullChanged)
    Q_PROPERTY(double energy READ energy NOTIFY energyChanged)
    Q_PROPERTY(double energyFull READ energyFull NOTIFY energyFullChanged)
    Q_PROPERTY(double energyFullDesign READ energyFullDesign NOTIFY energyFullDesignChanged)
    Q_PROPERTY(double energyRate READ energyRate NOTIFY energyRateChanged)
    Q_PROPERTY(double voltage READ voltage NOTIFY voltageChanged)
    Q_PROPERTY(double temperature READ temperature NOTIFY temperatureChanged)
    Q_PROPERTY(Technology technology READ technology CONSTANT)
    Q_PROPERTY(bool recalled READ isRecalled)
    Q_PROPERTY(QString recallVendor READ recallVendor)
    Q_PROPERTY(QString recallUrl READ recallUrl)
    Q_PROPERTY(QString serial READ serial CONSTANT)
    Q_PROPERTY(qlonglong remainingTime READ remainingTime NOTIFY remainingTimeChanged)
    Q_DECLARE_PRIVATE(Battery)
    friend class Device;

public:
    enum BatteryType { UnknownBattery, PdaBattery, UpsBattery,
                       PrimaryBattery, MouseBattery, KeyboardBattery,
                       KeyboardMouseBattery, CameraBattery,
                       PhoneBattery, MonitorBattery, GamingInputBattery,
                       BluetoothBattery
                     };
    Q_ENUM(BatteryType)

    
    enum ChargeState { NoCharge, Charging, Discharging, FullyCharged };
    Q_ENUM(ChargeState)

    
    enum Technology { UnknownTechnology = 0, LithiumIon, LithiumPolymer, LithiumIronPhosphate,
                      LeadAcid, NickelCadmium, NickelMetalHydride
                    };
    Q_ENUM(Technology)

private:
    explicit Battery(QObject *backendObject);

public:
    virtual ~Battery();

    static Type deviceInterfaceType()
    {
        return DeviceInterface::Battery;
    }

    bool isPresent() const;

#if SOLID_ENABLE_DEPRECATED_SINCE(5, 0)

    SOLID_DEPRECATED_VERSION(5, 0, "Use Battery::isPresent()")
    bool isPlugged() const { return isPresent(); }
#endif

    Solid::Battery::BatteryType type() const;

    int chargePercent() const;

    int capacity() const;

    bool isRechargeable() const;

    bool isPowerSupply() const;

    Solid::Battery::ChargeState chargeState() const;

    qlonglong timeToEmpty() const;

    qlonglong timeToFull() const;

    Solid::Battery::Technology technology() const;

    double energy() const;

    double energyFull() const;

    double energyFullDesign() const;

    double energyRate() const;

    double voltage() const;

    double temperature() const;

    bool isRecalled() const;

    QString recallVendor() const;

    QString recallUrl() const;

    QString serial() const;

    qlonglong remainingTime() const;

Q_SIGNALS:
    void presentStateChanged(bool newState, const QString &udi);

    void chargePercentChanged(int value, const QString &udi);

    void capacityChanged(int value, const QString &udi);

    void powerSupplyStateChanged(bool newState, const QString &udi);

    void chargeStateChanged(int newState, const QString &udi = QString());

    void timeToEmptyChanged(qlonglong time, const QString &udi);

    void timeToFullChanged(qlonglong time, const QString &udi);

    void energyChanged(double energy, const QString &udi);

    void energyFullChanged(double energy, const QString &udi);

    void energyFullDesignChanged(double energy, const QString &udi);

    void energyRateChanged(double energyRate, const QString &udi);

    void voltageChanged(double voltage, const QString &udi);

    void temperatureChanged(double temperature, const QString &udi);

     void remainingTimeChanged(qlonglong time, const QString &udi);
};
}

#endif