qlowenergycontroller_bluezdbus_p.h

Go to the documentation of this file.

// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QLOWENERGYCONTROLLERPRIVATEDBUS_P_H
#define QLOWENERGYCONTROLLERPRIVATEDBUS_P_H
 
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include "qlowenergycontroller.h"
#include "qlowenergycontrollerbase_p.h"
#include "qleadvertiser_bluezdbus_p.h"
 
#include <QtDBus/QDBusObjectPath>
 
namespace QtBluetoothPrivate {
 
class OrgBluezAdapter1Interface;
class OrgBluezBattery1Interface;
class OrgBluezDevice1Interface;
class OrgBluezGattCharacteristic1Interface;
class OrgBluezGattDescriptor1Interface;
class OrgBluezGattService1Interface;
class OrgFreedesktopDBusObjectManagerInterface;
class OrgFreedesktopDBusPropertiesInterface;
 
} // namespace QtBluetoothPrivate
 
QT_BEGIN_NAMESPACE
 
class QtBluezPeripheralApplication;
class QtBluezPeripheralConnectionManager;
class QDBusPendingCallWatcher;
 
class QLowEnergyControllerPrivateBluezDBus final : public QLowEnergyControllerPrivate
{
    Q_OBJECT
public:
    QLowEnergyControllerPrivateBluezDBus(const QString& adapterPathWithPeripheralSupport = {});
    ~QLowEnergyControllerPrivateBluezDBus() override;
 
    void init() override;
    void connectToDevice() override;
    void disconnectFromDevice() override;
 
    void discoverServices() override;
    void discoverServiceDetails(const QBluetoothUuid &service,
                                QLowEnergyService::DiscoveryMode mode) override;
 
    void readCharacteristic(
                const QSharedPointer<QLowEnergyServicePrivate> service,
                const QLowEnergyHandle charHandle) override;
    void readDescriptor(
                const QSharedPointer<QLowEnergyServicePrivate> service,
                const QLowEnergyHandle charHandle,
                const QLowEnergyHandle descriptorHandle) override;
 
    void writeCharacteristic(
                const QSharedPointer<QLowEnergyServicePrivate> service,
                const QLowEnergyHandle charHandle,
                const QByteArray &newValue,
                QLowEnergyService::WriteMode writeMode) override;
    void writeDescriptor(
                const QSharedPointer<QLowEnergyServicePrivate> service,
                const QLowEnergyHandle charHandle,
                const QLowEnergyHandle descriptorHandle,
                const QByteArray &newValue) override;
 
    void startAdvertising(
                const QLowEnergyAdvertisingParameters &params,
                const QLowEnergyAdvertisingData &advertisingData,
                const QLowEnergyAdvertisingData &scanResponseData) override;
    void stopAdvertising() override;
 
    void requestConnectionUpdate(
                const QLowEnergyConnectionParameters & params) override;
    void addToGenericAttributeList(
                        const QLowEnergyServiceData &service,
                        QLowEnergyHandle startHandle) override;
 
    int mtu() const override;
 
private:
    void connectToDeviceHelper();
    void resetController();
 
    void scheduleNextJob();
 
private slots:
    void devicePropertiesChanged(const QString &interface, const QVariantMap &changedProperties,
                                 const QStringList &invalidatedProperties);
    void characteristicPropertiesChanged(QLowEnergyHandle charHandle, const QString &interface,
                                    const QVariantMap &changedProperties,
                                    const QStringList &invalidatedProperties);
    void interfacesRemoved(const QDBusObjectPath &objectPath, const QStringList &interfaces);
 
    void onCharReadFinished(QDBusPendingCallWatcher *call);
    void onDescReadFinished(QDBusPendingCallWatcher *call);
    void onCharWriteFinished(QDBusPendingCallWatcher *call);
    void onDescWriteFinished(QDBusPendingCallWatcher *call);
private:
 
    QtBluetoothPrivate::OrgBluezAdapter1Interface* adapter{};
    QtBluetoothPrivate::OrgBluezDevice1Interface* device{};
    QtBluetoothPrivate::OrgFreedesktopDBusObjectManagerInterface* managerBluez{};
    QtBluetoothPrivate::OrgFreedesktopDBusPropertiesInterface* deviceMonitor{};
    QString adapterPathWithPeripheralSupport;
 
    int remoteMtu{-1};
    QtBluezPeripheralApplication* peripheralApplication{};
    QtBluezPeripheralConnectionManager* peripheralConnectionManager{};
    QLeDBusAdvertiser *advertiser{};
    void handleAdvertisingError();
    void handlePeripheralApplicationError();
    void handlePeripheralApplicationRegistered();
    void handlePeripheralConnectivityChanged(bool connected);
    void handlePeripheralCharacteristicValueUpdate(QLowEnergyHandle handle,
                                                   const QByteArray& value);
    void handlePeripheralDescriptorValueUpdate(QLowEnergyHandle characteristicHandle,
                                               QLowEnergyHandle descriptorHandle,
                                               const QByteArray& value);
    void handlePeripheralRemoteDeviceChanged(const QBluetoothAddress& address,
                                             const QString& name,
                                             quint16 mtu);
    bool pendingConnect = false;
    bool disconnectSignalRequired = false;
 
    struct GattCharacteristic
    {
        QSharedPointer<QtBluetoothPrivate::OrgBluezGattCharacteristic1Interface> characteristic;
        QSharedPointer<QtBluetoothPrivate::OrgFreedesktopDBusPropertiesInterface> charMonitor;
        QList<QSharedPointer<QtBluetoothPrivate::OrgBluezGattDescriptor1Interface>> descriptors;
    };
 
    struct GattService
    {
        QString servicePath;
        QList<GattCharacteristic> characteristics;
 
        bool hasBatteryService = false;
        QSharedPointer<QtBluetoothPrivate::OrgBluezBattery1Interface> batteryInterface;
    };
 
    QHash<QBluetoothUuid, GattService> dbusServices;
    QLowEnergyHandle runningHandle = 1;
 
    struct GattJob {
        enum JobFlag {
            Unset                   = 0x00,
            CharRead                = 0x01,
            CharWrite               = 0x02,
            DescRead                = 0x04,
            DescWrite               = 0x08,
            ServiceDiscovery        = 0x10,
            LastServiceDiscovery    = 0x20
        };
        Q_DECLARE_FLAGS(JobFlags, JobFlag)
 
        JobFlags flags = GattJob::Unset;
        QLowEnergyHandle handle;
        QByteArray value;
        QLowEnergyService::WriteMode writeMode = QLowEnergyService::WriteWithResponse;
        QSharedPointer<QLowEnergyServicePrivate> service;
    };
 
    QList<GattJob> jobs;
    bool jobPending = false;
 
    void prepareNextJob();
    void discoverBatteryServiceDetails(GattService &dbusData,
                                       QSharedPointer<QLowEnergyServicePrivate> serviceData);
    void executeClose(QLowEnergyController::Error newError);
};
 
QT_END_NAMESPACE
 
#endif // QLOWENERGYCONTROLLERPRIVATEDBUS_P_H