Merge the ServiceNotValidError and OperationError of QLEService
[qt:qtconnectivity.git] / src / bluetooth / gatoperipheral.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Javier de San Pedro <dev.git@javispedro.com>
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtBluetooth module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL21$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** In addition, as a special exception, Digia gives you certain additional
27 ** rights. These rights are described in the Digia Qt LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** $QT_END_LICENSE$
31 **
32 ****************************************************************************/
33
34 #ifndef GATOPERIPHERAL_H
35 #define GATOPERIPHERAL_H
36
37 #include <QtCore/QObject>
38 #include "libgato_global.h"
39 #include "gatouuid.h"
40 #include "gatoaddress.h"
41
42 QT_BEGIN_NAMESPACE
43
44 class GatoService;
45 class GatoCharacteristic;
46 class GatoDescriptor;
47 class GatoPeripheralPrivate;
48
49 class LIBGATO_EXPORT GatoPeripheral : public QObject
50 {
51     Q_OBJECT
52     Q_DECLARE_PRIVATE(GatoPeripheral)
53     Q_ENUMS(State)
54     Q_ENUMS(WriteType)
55     Q_PROPERTY(GatoAddress address READ address)
56     Q_PROPERTY(QString name READ name NOTIFY nameChanged)
57
58 public:
59     GatoPeripheral(const GatoAddress& addr, QObject *parent = 0);
60     ~GatoPeripheral();
61
62     enum State {
63         StateDisconnected,
64         StateConnecting,
65         StateConnected
66     };
67
68     enum WriteType {
69         WriteWithResponse = 0,
70         WriteWithoutResponse
71     };
72
73     State state() const;
74     GatoAddress address() const;
75     QString name() const;
76     QList<GatoService> services() const;
77
78     void parseEIR(quint8 data[], int len);
79     bool advertisesService(const GatoUUID &uuid) const;
80
81 public Q_SLOTS:
82     void connectPeripheral();
83     void disconnectPeripheral();
84     void discoverServices();
85     void discoverServices(const QList<GatoUUID>& serviceUUIDs);
86     void discoverCharacteristics(const GatoService &service);
87     void discoverCharacteristics(const GatoService &service, const QList<GatoUUID>& characteristicUUIDs);
88     void discoverDescriptors(const GatoCharacteristic &characteristic);
89     void readValue(const GatoCharacteristic &characteristic);
90     void readValue(const GatoDescriptor &descriptor);
91     void writeValue(const GatoCharacteristic &characteristic, const QByteArray &data, WriteType type = WriteWithResponse);
92     void writeValue(const GatoDescriptor &descriptor, const QByteArray &data);
93     void setNotification(const GatoCharacteristic &characteristic, bool enabled);
94
95 Q_SIGNALS:
96     void connected();
97     void disconnected();
98     void nameChanged();
99     void servicesDiscovered();
100     void characteristicsDiscovered(const GatoService &service);
101     void descriptorsDiscovered(const GatoCharacteristic &characteristic);
102     void valueUpdated(const GatoCharacteristic &characteristic, const QByteArray &value);
103     void descriptorValueUpdated(const GatoDescriptor &descriptor, const QByteArray &value);
104
105 private:
106     GatoPeripheralPrivate *const d_ptr;
107 };
108
109 QT_END_NAMESPACE
110
111 #endif // GATOPERIPHERAL_H