summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/qlowenergycharacteristicinfo.h
blob: c3121253b23be091a90230088eb3c50d3a84a5cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/***************************************************************************
**
** Copyright (C) 2013 BlackBerry Limited all rights reserved
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtBluetooth module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QLOWENERGYCHARACTERISTICINFO_H
#define QLOWENERGYCHARACTERISTICINFO_H
#include <QtCore/QSharedPointer>
#include <QtCore/QObject>
#include <QtBluetooth/QBluetoothUuid>
#include <QtBluetooth/QLowEnergyDescriptorInfo>

QT_BEGIN_NAMESPACE

class QBluetoothUuid;
class QLowEnergyCharacteristicInfoPrivate;

class Q_BLUETOOTH_EXPORT QLowEnergyCharacteristicInfo
{
    friend class QLowEnergyServiceInfo;
    friend class QLowEnergyServiceInfoPrivate;
    friend class QLowEnergyController;
    friend class QLowEnergyControllerPrivate;
    friend class QLowEnergyCharacteristicInfoPrivate;
public:

    enum Error {
        NotificationFail = 0x001,
        NotConnected = 0x002,
        UnknownError = 0x003
    };

    enum Property {
        Broadcasting = 0x01,
        Read = 0x02,
        WriteNoResponse = 0x04,
        Write = 0x08,
        Notify = 0x10,
        Indicate = 0x20,
        WriteSigned = 0x40,
        ExtendedProperty = 0x80
    };

    QLowEnergyCharacteristicInfo();
    QLowEnergyCharacteristicInfo(const QBluetoothUuid &uuid);
    QLowEnergyCharacteristicInfo(const QLowEnergyCharacteristicInfo &other);
    ~QLowEnergyCharacteristicInfo();

    QLowEnergyCharacteristicInfo &operator=(const QLowEnergyCharacteristicInfo &other);

    QString name() const;

    QBluetoothUuid uuid() const;

    void writeValue(const QByteArray &value);
    QByteArray value() const;

    int permissions() const;
    QVariantMap properties() const;
    QString handle() const;

    bool isNotificationCharacteristic() const;

    QList<QLowEnergyDescriptorInfo> descriptors() const;

    bool isValid() const;

    QString errorString() const;

protected:
    QSharedPointer<QLowEnergyCharacteristicInfoPrivate> d_ptr;

};

QT_END_NAMESPACE

#endif // QLOWENERGYCHARACTERISTICINFO_H