tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Philip Cohn-Cort c315170be5 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 05:54:11 +00:00
..
battery Finally, we have support for sending out Battery information. 2020-04-13 05:54:11 +00:00
clipboard SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
findmyphone SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
findthisdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
lockdevice SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
mousepad SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
mpriscontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
mprisremote SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
notifications [notifications] Drop no icon hack 2020-04-12 23:07:51 +00:00
pausemusic SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
photo SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
ping SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
presenter SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
remotecommands SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
remotecontrol SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
remotesystemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
runcommand SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
screensaver-inhibit SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
sendnotifications SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
sftp SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
share SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
sms SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
systemvolume SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
telephony SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-09 06:26:57 +02:00
CMakeLists.txt Make plugins work in SailfishConnect 2020-03-01 20:00:40 +00:00
kdeconnect.notifyrc [notifications] Drop no icon hack 2020-04-12 23:07:51 +00:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2020-04-07 06:11:40 +02:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Update README.txt in Plugins to include the current method to build a skeleton for a Plugin 2020-03-27 21:02:16 +05:30

README.txt 

Writing a plugin for KDE Connect
=================================

For the desktop client (this project):
--------------------------------------

1. Enter the "plugins" directory.
2. Copy the "ping" under a different name ("findmyphone" in this example).
3. Add "add_subdirectory(findmyphone)" to CMakeLists.txt after the others "add_subdirectory".
4. Enter the new "findmyphone" directory.
5. Edit CMakeLists.txt by replacing "ping" with "findmyphone".
6. Rename other files in this directory by replacing "ping" with "findmyphone"
7. Write a description of your plugin into "README"
8. Edit findmyphoneplugin.cpp and findmyphoneplugin.h.
  A. Change license header.
  B. Replace (case sensitive) "ping" with "findmyphone", "PingPlugin" with "FindMyPhonePlugin" and "PING" with "FINDMYPHONE".
9. Edit kdeconnect_findmyphone.json file:
  A. Replace "ping" with "findmyphone".
  B. Change name, description, icon, author, email, version, website, license info.
  C. Remove all the translations
  D. Set X-KDEConnect-SupportedPacketType and X-KDEConnect-OutgoingPacketType to the packet type your plugin will receive
     and send, respectively. In this example this is "kdeconnect.findmyphone". Make sure that this matches what is defined in
     the findmyplugin.h file (in the line "#define PACKET_TYPE_..."), and also in Android.
10. Now you have an empty skeleton to implement your new plugin logic.

For Android (project kdeconnect-android):
-----------------------------------------

1. Change directory to src/org/kde/kdeconnect/Plugins.
2. Copy "PingPlugin" under a different name ("FindMyPhonePlugin" in this example).
3. Enter the new "FindMyPhonePlugin" directory.
4. Rename "PingPlugin.java" to "FindMyPhonePlugin.java"
5. Edit it. Replace (case sensitive) "Ping" with "FindMyPhone", "ping" with "findmyphone", "PING" with "FINDMYPHONE"
   and "plugin_ping" with "plugin_findmyphone".
6. Open res/values/strings.xml. Find and copy the lines "pref_plugin_ping_desc" and "pref_plugin_ping" replacing "ping"
   with "findmyphone" and edit the plugin name and description between <string> </string>).
7. Now you have an empty skeleton to implement your new plugin logic.