powersync-plugins/nuki/bluez/bluetoothgattdescriptor.h

107 lines
3.2 KiB
C++

// SPDX-License-Identifier: GPL-3.0-or-later
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of nymea-plugins.
*
* nymea-plugins is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* nymea-plugins is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with nymea-plugins. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef BLUETOOTHGATTDESCRIPTOR_H
#define BLUETOOTHGATTDESCRIPTOR_H
#include <QObject>
#include <QBluetoothUuid>
#include <QDBusInterface>
#include <QDBusPendingCall>
#include <QDBusPendingCallWatcher>
#include "blueztypes.h"
// Note: DBus documentation https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/gatt-api.txt
class BluetoothManager;
class BluetoothGattCharacteristic;
class BluetoothGattDescriptor : public QObject
{
Q_OBJECT
Q_FLAGS(Properties)
friend class BluetoothManager;
friend class BluetoothGattCharacteristic;
public:
enum Property {
Unknown = 0x00,
Read = 0x01,
Write = 0x02,
EncryptRead = 0x04,
EncryptWrite = 0x08,
EncryptAuthenticatedRead = 0x10,
EncryptAuthenticatedWrite = 0x20,
SecureRead = 0x40, // Server only
SecureWrite = 0x80 // Server only
};
Q_DECLARE_FLAGS(Properties, Property)
QString name() const;
QBluetoothUuid uuid() const;
QByteArray value() const;
Properties properties() const;
private:
explicit BluetoothGattDescriptor(const QDBusObjectPath &path, const QVariantMap &properties, QObject *parent = 0);
QDBusObjectPath m_path;
QDBusInterface *m_descriptorInterface;
QBluetoothUuid m_uuid;
QByteArray m_value;
Properties m_properties;
QHash<QDBusPendingCallWatcher *, QByteArray> m_asyncWrites;
void processProperties(const QVariantMap &properties);
void setValueInternally(const QByteArray &value);
Properties parsePropertyFlags(const QStringList &descriptorProperties);
signals:
void valueChanged(const QByteArray &value);
void readingFinished(const QByteArray &value);
void writingFinished(const QByteArray &value);
private slots:
void onPropertiesChanged(const QString &interface, const QVariantMap &changedProperties, const QStringList &invalidatedProperties);
void onReadingFinished(QDBusPendingCallWatcher *call);
void onWritingFinished(QDBusPendingCallWatcher *call);
public slots:
bool readValue();
bool writeValue(const QByteArray &value);
};
Q_DECLARE_OPERATORS_FOR_FLAGS(BluetoothGattDescriptor::Properties)
QDebug operator<<(QDebug debug, BluetoothGattDescriptor *descriptor);
#endif // BLUETOOTHGATTDESCRIPTOR_H