tristan/kdeconnect-kde: Multi-platform app that allows your devices to communicate

Multi-platform app that allows your devices to communicate

Find a file

Aleix Pol 1a1969f42f Port to new QCA cmake structure, now it's called Qca and the target name is qca		2014-09-23 20:05:22 +02:00
cli	Port kdeconnect-cli away from kdelibs4supposrt	2014-09-22 02:26:06 +02:00
cmake	No need to have the FindQCA2	2014-09-23 19:24:34 +02:00
core	Port to new QCA cmake structure, now it's called Qca	2014-09-23 20:05:22 +02:00
fileitemactionplugin	Port fileitemactionplugin free of KDELibs4Support	2014-09-23 19:33:03 +02:00
icon	First approach to a KF5 port of KDE Connect	2014-06-16 20:02:07 +02:00
interfaces	qVariantCanConvert -> QVariant::canConvert	2014-09-23 19:55:07 +02:00
kcm	Port kcm free of KDELibs4Support	2014-09-22 09:35:40 +02:00
kded	Make kded compile without KDELibs4Support	2014-09-22 10:08:19 +02:00
kio	Port KIO free of KDElibs4Support	2014-09-23 19:33:03 +02:00
plasmoid	fix the Configure action	2014-09-10 10:19:44 +02:00
plugins	Port to new QCA cmake structure, now it's called Qca	2014-09-23 20:05:22 +02:00
tests	Port to new QCA cmake structure, now it's called Qca	2014-09-23 20:05:22 +02:00
.gitignore	Git: ignore *.kdev4	2014-06-29 17:46:39 +02:00
.reviewboardrc	Submit .reviewboardrc file	2014-06-18 02:42:07 +02:00
CMakeLists.txt	Port to new QCA cmake structure, now it's called Qca	2014-09-23 20:05:22 +02:00
COPYING	add missing licence file	2013-09-13 19:30:36 +02:00
README	Documentation	2013-09-24 14:14:34 +02:00

README

Class diagram
==============

   Backend_1  ...  Backend_N
           \   |  /
            Daemon
           /   |  \
     Device_1  ...  Device_N
                   /         \
                   |-Plugin_1 |-DeviceLink_1
                   |-Plugin_2 |-DeviceLink_2
                   |- ...     |-...
                   |-Plugin_N |-DeviceLink_N


Daemon instantiates Backends

Backends manage to create DeviceLinks with the devices they can reach, and Q_EMIT them to the Daemon.

When the Daemon receives a DeviceLink from a backend:
    - If it already knows the Device, adds the new DeviceLink to the existing Device, as a new way to reach it.
    - If not, it creates a new untrusted (yet to be paired) Device.

Devices contain a list of DeviceLinks, plus a list of Plugins (instantiated automatically)

Information for and from Plugins is encapsulated in NetworkPackages.

When a DeviceLink receives a NetworkPackage from the device in the other end, Device will notify all the plugins.

When a Plugin wants to send a NetworkPackage, it does so using the pointer to Device



The NetworkPackage format
=========================

NetworkPackages are independent and self-contained pieces of information that
are sent from one device to another (via a DeviceLink) serialized in json.

The basic structure of a NetworkPackage is the following:

{
  "id": 123456789,
  "type": "org.kde.whatever",
  "body": {

   },
  "version": 5
}

Each type of package defines what it should contain inside its "body", so only
the emisor plugin and receiver plugin of this type of package need agree about
its content. Each plugin should provide a README explaining what does it write
in the "body" section, to ease porting to other platforms.

If the package has a payload attached, it will also contain two more fields:
 "payloadSize": The size of the file, or -1 if it is a stream without known end
 "payloadTransferInfo": Another JSON Object containing the information that the
                        backend wants to send to the peer backend, to actually
                        transfer the payload.

Encrypted network packages have the following format:

 "type": is always set to "kdeconnect.encrypted".
 "id": contains a new valid id (ie: not the same id as the unencrypted package).
 "version": contains the package version.
 "body": contains a "data" array that carries the original package encrypted.

The "data" array is filled the following way:

 1. The original package is serialized.
 2. The serialized string is divided in chunks small enough to be encrypted with
    the other device's public key.
 3. Each chunk is encrypted and appended to the array in order.