SerialLink.h 4.94 KB
Newer Older
pixhawk's avatar
pixhawk committed
1
/*=====================================================================
pixhawk's avatar
pixhawk committed
2 3 4 5 6 7 8 9

QGroundControl Open Source Ground Control Station

(c) 2009 - 2011 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>

This file is part of the QGROUNDCONTROL project

    QGROUNDCONTROL is free software: you can redistribute it and/or modify
pixhawk's avatar
pixhawk committed
10 11 12
    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.
pixhawk's avatar
pixhawk committed
13 14

    QGROUNDCONTROL is distributed in the hope that it will be useful,
pixhawk's avatar
pixhawk committed
15 16 17
    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.
pixhawk's avatar
pixhawk committed
18

pixhawk's avatar
pixhawk committed
19
    You should have received a copy of the GNU General Public License
pixhawk's avatar
pixhawk committed
20 21
    along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.

pixhawk's avatar
pixhawk committed
22
======================================================================*/
23

pixhawk's avatar
pixhawk committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/**
 * @file
 *   @brief Brief Description
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

#ifndef SERIALLINK_H
#define SERIALLINK_H

#include <QObject>
#include <QThread>
#include <QMutex>
#include <QString>
Bill Bonney's avatar
Bill Bonney committed
39
#include <qserialport.h>
pixhawk's avatar
pixhawk committed
40 41 42
#include <configuration.h>
#include "SerialLinkInterface.h"

43 44 45
// convenience type for passing errors
typedef  QSerialPort::SerialPortError SerialLinkPortError_t;

pixhawk's avatar
pixhawk committed
46 47 48 49 50 51 52 53
/**
 * @brief The SerialLink class provides cross-platform access to serial links.
 * It takes care of the link management and provides a common API to higher
 * level communication layers. It is implemented as a wrapper class for a thread
 * that handles the serial communication. All methods have therefore to be thread-
 * safe.
 *
 */
54 55
class SerialLink : public SerialLinkInterface
{
pixhawk's avatar
pixhawk committed
56 57 58
    Q_OBJECT
    //Q_INTERFACES(SerialLinkInterface:LinkInterface)

59

pixhawk's avatar
pixhawk committed
60
public:
61
    SerialLink(QString portname = "",
62 63 64 65 66
               int baudrate=57600,
               bool flow=false,
               bool parity=false,
               int dataBits=8,
               int stopBits=1);
pixhawk's avatar
pixhawk committed
67 68 69 70
    ~SerialLink();

    static const int poll_interval = SERIAL_POLL_INTERVAL; ///< Polling interval, defined in configuration.h

71
    /** @brief Get a list of the currently available ports */
72
    QList<QString> getCurrentPorts();
73

74
    void requestReset();
75

76
    bool isConnected() const;
pixhawk's avatar
pixhawk committed
77 78 79 80 81
    qint64 bytesAvailable();

    /**
     * @brief The port handle
     */
82
    QString getPortName() const;
pixhawk's avatar
pixhawk committed
83 84 85
    /**
     * @brief The human readable port name
     */
86 87 88 89
    QString getName() const;
    int getBaudRate() const;
    int getDataBits() const;
    int getStopBits() const;
90 91

    // ENUM values
92 93 94 95 96
    int getBaudRateType() const;
    int getFlowType() const;
    int getParityType() const;
    int getDataBitsType() const;
    int getStopBitsType() const;
pixhawk's avatar
pixhawk committed
97 98

    /* Extensive statistics for scientific purposes */
99
    qint64 getNominalDataRate() const;
pixhawk's avatar
pixhawk committed
100 101 102 103 104 105
    qint64 getTotalUpstream();
    qint64 getCurrentUpstream();
    qint64 getMaxUpstream();
    qint64 getTotalDownstream();
    qint64 getCurrentDownstream();
    qint64 getMaxDownstream();
106 107
    qint64 getBitsSent() const;
    qint64 getBitsReceived() const;
pixhawk's avatar
pixhawk committed
108

109 110 111
    void loadSettings();
    void writeSettings();

pixhawk's avatar
pixhawk committed
112
    void run();
113
    void run2();
pixhawk's avatar
pixhawk committed
114

115 116 117
    int getLinkQuality() const;
    bool isFullDuplex() const;
    int getId() const;
pixhawk's avatar
pixhawk committed
118

119 120 121
signals: //[TODO] Refactor to Linkinterface
    void updateLink(LinkInterface*);

pixhawk's avatar
pixhawk committed
122 123 124
public slots:
    bool setPortName(QString portName);
    bool setBaudRate(int rate);
125 126 127
    bool setDataBits(int dataBits);
    bool setStopBits(int stopBits);

128 129 130
    // Set string rate
    bool setBaudRateString(const QString& rate);

131
    // Set ENUM values
pixhawk's avatar
pixhawk committed
132 133 134 135 136 137
    bool setBaudRateType(int rateIndex);
    bool setFlowType(int flow);
    bool setParityType(int parity);
    bool setDataBitsType(int dataBits);
    bool setStopBitsType(int stopBits);

138
    void readBytes();
pixhawk's avatar
pixhawk committed
139 140 141 142 143 144 145 146 147 148
    /**
     * @brief Write a number of bytes to the interface.
     *
     * @param data Pointer to the data byte array
     * @param size The size of the bytes array
     **/
    void writeBytes(const char* data, qint64 length);
    bool connect();
    bool disconnect();

149
    void linkError(SerialLinkPortError_t error);
150

pixhawk's avatar
pixhawk committed
151
protected:
Bill Bonney's avatar
Bill Bonney committed
152 153 154 155 156 157 158 159
    quint64 m_bytesRead;
    QSerialPort* m_port;
    int m_baud;
    int m_dataBits;
    int m_flowControl;
    int m_stopBits;
    int m_parity;
    QString m_portName;
160
//    QString m_name;
Bill Bonney's avatar
Bill Bonney committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174
    int m_timeout;
    int m_id;

    quint64 m_bitsSentTotal;
    quint64 m_bitsSentShortTerm;
    quint64 m_bitsSentCurrent;
    quint64 m_bitsSentMax;
    quint64 m_bitsReceivedTotal;
    quint64 m_bitsReceivedShortTerm;
    quint64 m_bitsReceivedCurrent;
    quint64 m_bitsReceivedMax;
    quint64 m_connectionStartTime;
    QMutex m_statisticsMutex;
    QMutex m_dataMutex;
175
    QMutex m_writeMutex;
176
    QList<QString> m_ports;
pixhawk's avatar
pixhawk committed
177

oberion's avatar
oberion committed
178
private:
179 180
    volatile bool m_stopp;
    volatile bool m_reqReset;
oberion's avatar
oberion committed
181
	QMutex m_stoppMutex;
182
    QByteArray m_transmitBuffer;
oberion's avatar
oberion committed
183

pixhawk's avatar
pixhawk committed
184 185 186
    bool hardwareConnect();

signals:
187
    void aboutToCloseFlag();
pixhawk's avatar
pixhawk committed
188 189 190 191

};

#endif // SERIALLINK_H