tristan/kdeconnect-kde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kdeconnect-kde/plugins
History
Friedrich W. H. Kossebau 0e023346a3 New plugin: Find this device (v2, now hopefully fine for all compilers) 
Summary:
Allows other devices to make this device discoverable via a
kdeconnect.findmyphone.request command, if running.

Currently supports playing a sound.

Counterpart to FindMyPhone plugin

Test Plan:
Connect with other device running KDE Connect (with Plasmoid).
Select a working play sound in the Find My Device plugin settings.
On other device trigger Find My Phone button for this device in KDE Connect
Plasmoid and notice this device playing the configured sound.

Reviewers: #kde_connect, nicolasfella

Reviewed By: #kde_connect, nicolasfella

Subscribers: kdeconnect, sredman, mtijink, apol, nicolasfella

Tags: #kde_connect

Differential Revision: https://phabricator.kde.org/D11773
2018-05-15 22:15:21 +02:00
..
battery Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
clipboard Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
contacts SVN_SILENT made messages (.desktop file) - always resolve ours 2018-05-04 05:28:59 +02:00
findmyphone Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
findthisdevice New plugin: Find this device (v2, now hopefully fine for all compilers) 2018-05-15 22:15:21 +02:00
lockdevice Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
mousepad Enable desktop2desktop keyboard input 2018-05-12 17:52:07 +02:00
mpriscontrol Support file url album art - Desktop 2018-03-25 13:45:01 +02:00
mprisremote Request status when connecting 2018-04-28 00:23:52 +02:00
notifications Fix addNotification being called twice 2018-03-24 21:28:43 +01:00
pausemusic Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
ping Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
remotecommands Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
remotecontrol Remove unused "Encoding": "UTF-8" from plugins' metadata JSON 2018-03-17 23:32:27 +01:00
remotekeyboard SVN_SILENT made messages (.desktop file) - always resolve ours 2018-04-07 05:22:03 +02:00
runcommand Do not require Frameworks 5.45 2018-05-10 19:48:40 +02:00
screensaver-inhibit Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
sendnotifications Clean-up requirements: cmake 3.0, qt 5.7, use min versions, deduplicate KF5 2018-03-17 23:34:33 +01:00
sftp Added -o reconnect to sshfs 2018-04-09 18:30:14 +02:00
share Add a method for creating simple notifications 2018-03-18 12:52:22 +01:00
telephony Optionally include sms app 2018-03-25 20:48:38 +02:00
CMakeLists.txt New plugin: Find this device (v2, now hopefully fine for all compilers) 2018-05-15 22:15:21 +02:00
kdeconnect.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2018-01-29 05:02:00 +01:00
kdeconnect_plugin.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2017-09-19 04:58:52 +02:00
Messages.sh Figure out Messages.sh after code refactoring 2014-06-17 18:45:47 +02:00
README.txt Rename NetworkPackage -> NetworkPacket 2018-03-05 20:03:23 +01:00

README.txt 

Writting 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".
1. 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.desktop 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).
1. 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. Open src/org/kde/kdeconnect/Plugins/PluginFactory.java.
  A. Copy "import … PingPlugin" line with replacing "PingPlugin" with "FindMyPhonePlugin".
  B. Copy "PluginFactory.registerPlugin(PingPlugin.class);" line with replacing "PingPlugin" with "FindMyPhonePlugin".
8. Open src/org/kde/kdeconnect/NetworkPacket.java. Copy a "public final static String PACKET_TYPE_PING = …" line
   replacing "PING" with the packet type you will be using (should match the desktop client).
9. Now you have an empty skeleton to implement your new plugin logic.