LinkManager.h 9.16 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
9 10


11 12
/// @file
///     @author Lorenz Meier <mavteam@student.ethz.ch>
pixhawk's avatar
pixhawk committed
13 14 15 16 17

#ifndef _LINKMANAGER_H_
#define _LINKMANAGER_H_

#include <QList>
18
#include <QMultiMap>
19
#include <QMutex>
20

21
#include "LinkConfiguration.h"
22
#include "LinkInterface.h"
Don Gagne's avatar
Don Gagne committed
23
#include "QGCLoggingCategory.h"
24
#include "QGCToolbox.h"
Don Gagne's avatar
Don Gagne committed
25 26
#include "ProtocolInterface.h"
#include "MAVLinkProtocol.h"
Gus Grubba's avatar
Gus Grubba committed
27
#if !defined(__mobile__)
Don Gagne's avatar
Don Gagne committed
28
#include "LogReplayLink.h"
dogmaphobic's avatar
dogmaphobic committed
29
#endif
Don Gagne's avatar
Don Gagne committed
30
#include "QmlObjectListModel.h"
31

Gus Grubba's avatar
Gus Grubba committed
32
#ifndef NO_SERIAL_LINK
Don Gagne's avatar
Don Gagne committed
33
    #include "SerialLink.h"
dogmaphobic's avatar
dogmaphobic committed
34
#endif
35

36
#ifdef QT_DEBUG
Don Gagne's avatar
Don Gagne committed
37
    #include "MockLink.h"
38
#endif
39

Don Gagne's avatar
Don Gagne committed
40
Q_DECLARE_LOGGING_CATEGORY(LinkManagerLog)
Don Gagne's avatar
Don Gagne committed
41
Q_DECLARE_LOGGING_CATEGORY(LinkManagerVerboseLog)
Don Gagne's avatar
Don Gagne committed
42

43
class QGCApplication;
44 45
class UDPConfiguration;
class AutoConnectSettings;
46

47 48 49 50 51 52
/// Manage communication links
///
/// The Link Manager organizes the physical Links. It can manage arbitrary
/// links and takes care of connecting them as well assigning the correct
/// protocol instance to transport the link data into the application.

53
class LinkManager : public QGCTool
54
{
pixhawk's avatar
pixhawk committed
55
    Q_OBJECT
56

Don Gagne's avatar
Don Gagne committed
57 58
    /// Unit Test has access to private constructor/destructor
    friend class LinkManagerTest;
59

Don Gagne's avatar
Don Gagne committed
60
public:
61
    LinkManager(QGCApplication* app, QGCToolbox* toolbox);
62
    ~LinkManager();
63

64 65 66 67
    Q_PROPERTY(bool isBluetoothAvailable                READ isBluetoothAvailable                                               CONSTANT)
    Q_PROPERTY(QmlObjectListModel*  linkConfigurations  READ _qmlLinkConfigurations                                             NOTIFY linkConfigurationsChanged)
    Q_PROPERTY(QStringList          linkTypeStrings     READ linkTypeStrings                                                    CONSTANT)
    Q_PROPERTY(QStringList          serialBaudRates     READ serialBaudRates                                                    CONSTANT)
68 69 70 71 72 73 74 75 76 77
    Q_PROPERTY(QStringList          serialPortStrings   READ serialPortStrings                                                  NOTIFY commPortStringsChanged)
    Q_PROPERTY(QStringList          serialPorts         READ serialPorts                                                        NOTIFY commPortsChanged)

    // Create/Edit Link Configuration
    Q_INVOKABLE LinkConfiguration*  createConfiguration         (int type, const QString& name);
    Q_INVOKABLE LinkConfiguration*  startConfigurationEditing   (LinkConfiguration* config);
    Q_INVOKABLE void                cancelConfigurationEditing  (LinkConfiguration* config) { delete config; }
    Q_INVOKABLE bool                endConfigurationEditing     (LinkConfiguration* config, LinkConfiguration* editedConfig);
    Q_INVOKABLE bool                endCreateConfiguration      (LinkConfiguration* config);
    Q_INVOKABLE void                removeConfiguration         (LinkConfiguration* config);
Don Gagne's avatar
Don Gagne committed
78 79 80

    // Property accessors

dogmaphobic's avatar
dogmaphobic committed
81
    bool isBluetoothAvailable       (void);
Don Gagne's avatar
Don Gagne committed
82

83 84 85 86 87
    QList<LinkInterface*> links                 (void);
    QStringList         linkTypeStrings         (void) const;
    QStringList         serialBaudRates         (void);
    QStringList         serialPortStrings       (void);
    QStringList         serialPorts             (void);
88 89 90 91 92 93 94 95 96 97

    /// Load list of link configurations from disk
    void loadLinkConfigurationList();

    /// Save list of link configurations from disk
    void saveLinkConfigurationList();

    /// Suspend automatic confguration updates (during link maintenance for instance)
    void suspendConfigurationUpdates(bool suspend);

98
    /// Sets the flag to suspend the all new connections
99 100
    ///     @param reason User visible reason to suspend connections
    void setConnectionsSuspended(QString reason);
101

102
    /// Sets the flag to allow new connections to be made
103
    void setConnectionsAllowed(void) { _connectionsSuspended = false; }
104

105
    /// Creates, connects (and adds) a link  based on the given configuration instance.
Don Gagne's avatar
Don Gagne committed
106
    /// Link takes ownership of config.
Don Gagne's avatar
Don Gagne committed
107 108 109 110
    LinkInterface* createConnectedLink(SharedLinkConfigurationPointer& config);

    // This should only be used by Qml code
    Q_INVOKABLE void createConnectedLink(LinkConfiguration* config);
111

112
    /// Creates, connects (and adds) a link  based on the given configuration name.
Don Gagne's avatar
Don Gagne committed
113
    LinkInterface* createConnectedLink(const QString& name);
114

Don Gagne's avatar
Don Gagne committed
115 116
    /// Disconnects all existing links
    void disconnectAll(void);
117

118 119
    /// Connect the specified link
    bool connectLink(LinkInterface* link);
120

Don Gagne's avatar
Don Gagne committed
121 122
    /// Disconnect the specified link
    Q_INVOKABLE void disconnectLink(LinkInterface* link);
123

124 125 126 127
    // The following APIs are public but should not be called in normal use. The are mainly exposed
    // here for unit test code.
    void _deleteLink(LinkInterface* link);
    void _addLink(LinkInterface* link);
128

Don Gagne's avatar
Don Gagne committed
129
    // Called to signal app shutdown. Disconnects all links while turning off auto-connect.
Don Gagne's avatar
Don Gagne committed
130
    Q_INVOKABLE void shutdown(void);
Don Gagne's avatar
Don Gagne committed
131

Don Gagne's avatar
Don Gagne committed
132 133 134 135 136
#ifdef QT_DEBUG
    // Only used by unit test tp restart after a shutdown
    void restart(void) { setConnectionsAllowed(); }
#endif

137 138 139
    /// @return true: specified link is an autoconnect link
    bool isAutoconnectLink(LinkInterface* link);

140 141 142
    // Override from QGCTool
    virtual void setToolbox(QGCToolbox *toolbox);

143 144 145 146 147 148 149 150 151 152 153
    /// @return This mavlink channel is never assigned to a vehicle.
    uint8_t reservedMavlinkChannel(void) { return 0; }

    /// If you are going to hold a reference to a LinkInterface* in your object you must reference count it
    /// by using this method to get access to the shared pointer.
    SharedLinkInterfacePointer sharedLinkInterfacePointerForLink(LinkInterface* link);

    bool containsLink(LinkInterface* link);

    SharedLinkConfigurationPointer addConfiguration(LinkConfiguration* config);

154 155
    void startAutoConnectedLinks(void);

156 157 158 159 160 161 162
    /// Reserves a mavlink channel for use
    /// @return Mavlink channel index, 0 for no channels available
    int _reserveMavlinkChannel(void);

    /// Free the specified mavlink channel for re-use
    void _freeMavlinkChannel(int channel);

163
    static const char*  settingsGroup;
Don Gagne's avatar
Don Gagne committed
164

165
signals:
pixhawk's avatar
pixhawk committed
166
    void newLink(LinkInterface* link);
Don Gagne's avatar
Don Gagne committed
167 168

    // Link has been deleted. You may not necessarily get a linkInactive before the link is deleted.
169
    void linkDeleted(LinkInterface* link);
Don Gagne's avatar
Don Gagne committed
170 171

    // Link has been connected, but no Vehicle seen on link yet.
172
    void linkConnected(LinkInterface* link);
Don Gagne's avatar
Don Gagne committed
173 174

    // Link disconnected, all vehicles on link should be gone as well.
175
    void linkDisconnected(LinkInterface* link);
Don Gagne's avatar
Don Gagne committed
176 177 178 179 180 181 182

    // New vehicle has been seen on the link.
    void linkActive(LinkInterface* link, int vehicleId, int vehicleFirmwareType, int vehicleType);

    // No longer hearing from any vehicles on this link.
    void linkInactive(LinkInterface* link);

183
    void commPortStringsChanged();
184 185
    void commPortsChanged();
    void linkConfigurationsChanged();
186

187 188 189
private slots:
    void _linkConnected(void);
    void _linkDisconnected(void);
190
    void _linkConnectionRemoved(LinkInterface* link);
Gus Grubba's avatar
Gus Grubba committed
191
#ifndef NO_SERIAL_LINK
Don Gagne's avatar
Don Gagne committed
192
    void _activeLinkCheck(void);
Don Gagne's avatar
Don Gagne committed
193
#endif
194

195
private:
196
    QmlObjectListModel* _qmlLinkConfigurations  (void) { return &_qmlConfigurations; }
197
    bool _connectionsSuspendedMsg(void);
Don Gagne's avatar
Don Gagne committed
198
    void _updateAutoConnectLinks(void);
199 200
    void _updateSerialPorts();
    void _fixUnnamed(LinkConfiguration* config);
201
    void _removeConfiguration(LinkConfiguration* config);
Don Gagne's avatar
Don Gagne committed
202

Gus Grubba's avatar
Gus Grubba committed
203
#ifndef NO_SERIAL_LINK
Don Gagne's avatar
Don Gagne committed
204
    SerialConfiguration* _autoconnectConfigurationsContainsPort(const QString& portName);
dogmaphobic's avatar
dogmaphobic committed
205
#endif
206 207 208 209 210 211

    bool    _configUpdateSuspended;                     ///< true: stop updating configuration list
    bool    _configurationsLoaded;                      ///< true: Link configurations have been loaded
    bool    _connectionsSuspended;                      ///< true: all new connections should not be allowed
    QString _connectionsSuspendedReason;                ///< User visible reason for suspension
    QTimer  _portListTimer;
212
    uint32_t _mavlinkChannelsUsedBitMask;
213

214 215
    AutoConnectSettings*    _autoConnectSettings;
    MAVLinkProtocol*        _mavlinkProtocol;
216 217 218 219 220

    QList<SharedLinkInterfacePointer>       _sharedLinks;
    QList<SharedLinkConfigurationPointer>   _sharedConfigurations;
    QList<SharedLinkConfigurationPointer>   _sharedAutoconnectConfigurations;
    QmlObjectListModel                      _qmlConfigurations;
Don Gagne's avatar
Don Gagne committed
221

222
    QMap<QString, int>  _autoconnectWaitList;   ///< key: QGCSerialPortInfo.systemLocation, value: wait count
223
    QStringList _commPortList;
224
    QStringList _commPortDisplayList;
225

Gus Grubba's avatar
Gus Grubba committed
226
#ifndef NO_SERIAL_LINK
227 228 229
    QTimer              _activeLinkCheckTimer;                  ///< Timer which checks for a vehicle showing up on a usb direct link
    QList<SerialLink*>  _activeLinkCheckList;                   ///< List of links we are waiting for a vehicle to show up on
    static const int    _activeLinkCheckTimeoutMSecs = 15000;   ///< Amount of time to wait for a heatbeat. Keep in mind ArduPilot stack heartbeat is slow to come.
Don Gagne's avatar
Don Gagne committed
230
#endif
Don Gagne's avatar
Don Gagne committed
231

232 233 234
    static const char*  _defaultUPDLinkName;
    static const int    _autoconnectUpdateTimerMSecs;
    static const int    _autoconnectConnectDelayMSecs;
pixhawk's avatar
pixhawk committed
235 236
};

237
#endif