kdeconnect-kde/plugins/battery/batteryplugin.h

47 lines
1.2 KiB
C
Raw Normal View History

/**
* SPDX-FileCopyrightText: 2013 Albert Vaca <albertvaka@gmail.com>
*
* SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
#ifndef BATTERYPLUGIN_H
#define BATTERYPLUGIN_H
#include <core/kdeconnectplugin.h>
Finally, we have support for sending out Battery information. ## Summary The core idea is as follows: 1. When a Link loads the BatteryPlugin, we query Solid for a list of batteries. 1. If the list is empty, we print a warning message and return quickly 2. Otherwise, we connect *two signals* to every object in that list 2. We send out a single new NetworkPacket as soon as we've processed that list 3. When either of those two signals emits, we send another new NetworkPacket ### Multi-battery Support BUG: 357193 To handle devices with multiple batteries (requested in that bug), we average together the battery percentages. This also includes a new field in the packet for 'number of batteries' called `batteryQuantity`. For backwards compatibility, we can assume it has a default value of one. This should ensure we support - devices with no batteries at all (like many desktop machines) - devices with hot-pluggable batteries (like those laptops with detachable screens) ### Concerns Note that the implementation isn't perfect. We'll need some new localizable text to make it clear that we now support sending battery status information. Then there's a rather significant question: maybe we should have two battery plugins on each client, like we do for the `findmyphone`/`findthisdevice` plugins? ## Test Plan We need to ensure that other clients (including those using the Android codebase) will respond correctly. The main things to look at are 1. are these new packets sent when the plugin is enabled, and not sent when it's disabled? 2. is the charge percentage accurate? 3. is the charge state (charging, discharging, or full) accurate? and 4. do we see the correct number of warnings for low-battery?
2020-04-13 06:54:11 +01:00
#define PACKET_TYPE_BATTERY QStringLiteral("kdeconnect.battery")
class BatteryPlugin : public KdeConnectPlugin
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.kdeconnect.device.battery")
Q_PROPERTY(int charge READ charge NOTIFY refreshed)
Q_PROPERTY(bool isCharging READ isCharging NOTIFY refreshed)
public:
explicit BatteryPlugin(QObject *parent, const QVariantList &args);
bool receivePacket(const NetworkPacket &np) override;
void connected() override;
QString dbusPath() const override;
int charge() const;
bool isCharging() const;
Q_SIGNALS:
Q_SCRIPTABLE void refreshed(bool isCharging, int charge);
Finally, we have support for sending out Battery information. ## Summary The core idea is as follows: 1. When a Link loads the BatteryPlugin, we query Solid for a list of batteries. 1. If the list is empty, we print a warning message and return quickly 2. Otherwise, we connect *two signals* to every object in that list 2. We send out a single new NetworkPacket as soon as we've processed that list 3. When either of those two signals emits, we send another new NetworkPacket ### Multi-battery Support BUG: 357193 To handle devices with multiple batteries (requested in that bug), we average together the battery percentages. This also includes a new field in the packet for 'number of batteries' called `batteryQuantity`. For backwards compatibility, we can assume it has a default value of one. This should ensure we support - devices with no batteries at all (like many desktop machines) - devices with hot-pluggable batteries (like those laptops with detachable screens) ### Concerns Note that the implementation isn't perfect. We'll need some new localizable text to make it clear that we now support sending battery status information. Then there's a rather significant question: maybe we should have two battery plugins on each client, like we do for the `findmyphone`/`findthisdevice` plugins? ## Test Plan We need to ensure that other clients (including those using the Android codebase) will respond correctly. The main things to look at are 1. are these new packets sent when the plugin is enabled, and not sent when it's disabled? 2. is the charge percentage accurate? 3. is the charge state (charging, discharging, or full) accurate? and 4. do we see the correct number of warnings for low-battery?
2020-04-13 06:54:11 +01:00
private:
void slotChargeChanged();
// Keep these values in sync with THRESHOLD* constants in
// kdeconnect-android:BatteryPlugin.java
// see README for their meaning
enum ThresholdBatteryEvent { ThresholdNone = 0, ThresholdBatteryLow = 1 };
int m_charge = -1;
bool m_isCharging = false;
};
#endif