BluetoothLink.h 5.6 KB
Newer Older
1 2
/****************************************************************************
 *
3
 *   (c) 2009-2018 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
dogmaphobic's avatar
dogmaphobic committed
9 10 11 12 13 14 15 16 17


/*!
 * @file
 *   @brief Bluetooth connection for unmanned vehicles
 *   @author Gus Grubba <mavlink@grubba.com>
 *
 */

18
#pragma once
dogmaphobic's avatar
dogmaphobic committed
19 20 21 22 23 24 25 26 27

#include <QString>
#include <QList>
#include <QMutex>
#include <QMutexLocker>
#include <QQueue>
#include <QByteArray>
#include <QBluetoothDeviceInfo>
#include <QtBluetooth/QBluetoothSocket>
dogmaphobic's avatar
dogmaphobic committed
28 29
#include <qbluetoothserviceinfo.h>
#include <qbluetoothservicediscoveryagent.h>
dogmaphobic's avatar
dogmaphobic committed
30 31 32 33 34

#include "QGCConfig.h"
#include "LinkManager.h"

class QBluetoothDeviceDiscoveryAgent;
dogmaphobic's avatar
dogmaphobic committed
35
class QBluetoothServiceDiscoveryAgent;
dogmaphobic's avatar
dogmaphobic committed
36

37 38 39 40 41 42 43 44 45 46 47 48
class BluetoothData
{
public:
    BluetoothData()
    {
    }
    BluetoothData(const BluetoothData& other)
    {
        *this = other;
    }
    bool operator==(const BluetoothData& other)
    {
dogmaphobic's avatar
dogmaphobic committed
49 50 51 52 53
#ifdef __ios__
        return uuid == other.uuid && name == other.name;
#else
        return name == other.name && address == other.address;
#endif
54 55 56 57
    }
    BluetoothData& operator=(const BluetoothData& other)
    {
        name = other.name;
dogmaphobic's avatar
dogmaphobic committed
58 59 60
#ifdef __ios__
        uuid = other.uuid;
#else
61
        address = other.address;
dogmaphobic's avatar
dogmaphobic committed
62
#endif
63 64 65
        return *this;
    }
    QString name;
dogmaphobic's avatar
dogmaphobic committed
66 67 68
#ifdef __ios__
    QBluetoothUuid uuid;
#else
69
    QString address;
dogmaphobic's avatar
dogmaphobic committed
70
#endif
71 72
};

dogmaphobic's avatar
dogmaphobic committed
73 74 75 76 77 78 79 80 81 82
class BluetoothConfiguration : public LinkConfiguration
{
    Q_OBJECT

public:

    BluetoothConfiguration(const QString& name);
    BluetoothConfiguration(BluetoothConfiguration* source);
    ~BluetoothConfiguration();

83 84 85
    Q_PROPERTY(QString      devName     READ devName    WRITE setDevName  NOTIFY devNameChanged)
    Q_PROPERTY(QString      address     READ address                      NOTIFY addressChanged)
    Q_PROPERTY(QStringList  nameList    READ nameList                     NOTIFY nameListChanged)
dogmaphobic's avatar
dogmaphobic committed
86 87 88 89 90
    Q_PROPERTY(bool         scanning    READ scanning                     NOTIFY scanningChanged)

    Q_INVOKABLE void        startScan   ();
    Q_INVOKABLE void        stopScan    ();

91
    QString     devName                 () { return _device.name; }
dogmaphobic's avatar
dogmaphobic committed
92
    QString     address                 ();
93
    QStringList nameList                () { return _nameList; }
94
    bool        scanning                () { return _deviceDiscover != nullptr; }
dogmaphobic's avatar
dogmaphobic committed
95

96 97 98
    BluetoothData    device             () { return _device; }

    void        setDevName              (const QString& name);
dogmaphobic's avatar
dogmaphobic committed
99 100 101 102 103 104 105 106

    /// From LinkConfiguration
    LinkType    type                    () { return LinkConfiguration::TypeBluetooth; }
    void        copyFrom                (LinkConfiguration* source);
    void        loadSettings            (QSettings& settings, const QString& root);
    void        saveSettings            (QSettings& settings, const QString& root);
    void        updateSettings          ();
    QString     settingsURL             () { return "BluetoothSettings.qml"; }
107
    QString     settingsTitle           ();
dogmaphobic's avatar
dogmaphobic committed
108 109 110 111 112 113 114

public slots:
    void        deviceDiscovered        (QBluetoothDeviceInfo info);
    void        doneScanning            ();

signals:
    void        newDevice               (QBluetoothDeviceInfo info);
115
    void        devNameChanged          ();
dogmaphobic's avatar
dogmaphobic committed
116
    void        addressChanged          ();
117
    void        nameListChanged         ();
dogmaphobic's avatar
dogmaphobic committed
118 119 120 121
    void        scanningChanged         ();

private:
    QBluetoothDeviceDiscoveryAgent*     _deviceDiscover;
122 123 124
    BluetoothData                       _device;
    QStringList                         _nameList;
    QList<BluetoothData>                _deviceList;
dogmaphobic's avatar
dogmaphobic committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
};

class BluetoothLink : public LinkInterface
{
    Q_OBJECT

    friend class BluetoothConfiguration;
    friend class LinkManager;

public:
    void    requestReset            () { }
    bool    isConnected             () const;
    QString getName                 () const;

    // Extensive statistics for scientific purposes
    qint64  getConnectionSpeed      () const;
    qint64  getCurrentInDataRate    () const;
    qint64  getCurrentOutDataRate   () const;

    void run();

    // These are left unimplemented in order to cause linker errors which indicate incorrect usage of
    // connect/disconnect on link directly. All connect/disconnect calls should be made through LinkManager.
    bool    connect                 (void);
    bool    disconnect              (void);

    LinkConfiguration* getLinkConfiguration() { return _config; }

public slots:
    void    readBytes               ();
    void    deviceConnected         ();
    void    deviceDisconnected      ();
    void    deviceError             (QBluetoothSocket::SocketError error);
dogmaphobic's avatar
dogmaphobic committed
158 159 160 161
#ifdef __ios__
    void    serviceDiscovered       (const QBluetoothServiceInfo &info);
    void    discoveryFinished       ();
#endif
dogmaphobic's avatar
dogmaphobic committed
162 163 164 165 166 167 168 169

protected:

    BluetoothConfiguration*     _config;
    bool                        _connectState;

private:
    // Links are only created/destroyed by LinkManager so constructor/destructor is not public
170
    BluetoothLink(SharedLinkConfigurationPointer& config);
dogmaphobic's avatar
dogmaphobic committed
171 172 173 174 175 176 177 178
    ~BluetoothLink();

    // From LinkInterface
    bool _connect               (void);
    void _disconnect            (void);

    bool _hardwareConnect       ();
    void _restartConnection     ();
179 180

private slots:
181
    void _writeBytes            (const QByteArray bytes);
182 183

private:
dogmaphobic's avatar
dogmaphobic committed
184
    void _createSocket          ();
dogmaphobic's avatar
dogmaphobic committed
185 186 187

private:

dogmaphobic's avatar
dogmaphobic committed
188 189 190 191 192 193 194
    QBluetoothSocket*           _targetSocket;
#ifdef __ios__
    QBluetoothServiceDiscoveryAgent* _discoveryAgent;
#endif

    bool                        _shutDown;

dogmaphobic's avatar
dogmaphobic committed
195 196
};