Joystick.h 5.59 KB
Newer Older
1 2 3 4 5 6 7 8 9
/****************************************************************************
 *
 *   (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.
 *
 ****************************************************************************/

10 11 12 13 14 15 16 17 18

#ifndef Joystick_H
#define Joystick_H

#include <QObject>
#include <QThread>

#include "QGCLoggingCategory.h"
#include "Vehicle.h"
19
#include "MultiVehicleManager.h"
20 21

Q_DECLARE_LOGGING_CATEGORY(JoystickLog)
22
Q_DECLARE_LOGGING_CATEGORY(JoystickValuesLog)
23 24 25 26 27 28

class Joystick : public QThread
{
    Q_OBJECT
    
public:
29 30
    Joystick(const QString& name, int axisCount, int buttonCount, int hatCount, MultiVehicleManager* multiVehicleManager);

31
    ~Joystick();
32

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
    typedef struct {
        int     min;
        int     max;
        int     center;
        bool    reversed;
    } Calibration_t;
    
    typedef enum {
        rollFunction,
        pitchFunction,
        yawFunction,
        throttleFunction,
        maxFunction
    } AxisFunction_t;
    
    typedef enum {
        ThrottleModeCenterZero,
        ThrottleModeDownZero,
        ThrottleModeMax
    } ThrottleMode_t;
    
    Q_PROPERTY(QString name READ name CONSTANT)
    
Don Gagne's avatar
Don Gagne committed
56
    Q_PROPERTY(bool calibrated MEMBER _calibrated NOTIFY calibratedChanged)
57
    
58
    Q_PROPERTY(int totalButtonCount  READ totalButtonCount    CONSTANT)
59
    Q_PROPERTY(int axisCount    READ axisCount      CONSTANT)
60 61 62 63
    
    Q_PROPERTY(QStringList actions READ actions CONSTANT)
    
    Q_PROPERTY(QVariantList buttonActions READ buttonActions NOTIFY buttonActionsChanged)
Don Gagne's avatar
Don Gagne committed
64 65
    Q_INVOKABLE void setButtonAction(int button, const QString& action);
    Q_INVOKABLE QString getButtonAction(int button);
66 67
    
    Q_PROPERTY(int throttleMode READ throttleMode WRITE setThrottleMode NOTIFY throttleModeChanged)
68 69 70 71

    // Property accessors

    int axisCount(void) { return _axisCount; }
72
    int totalButtonCount(void) { return _totalButtonCount; }
73 74
    
    /// Start the polling thread which will in turn emit joystick signals
75
    void startPolling(Vehicle* vehicle);
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
    void stopPolling(void);
    
    void setCalibration(int axis, Calibration_t& calibration);
    Calibration_t getCalibration(int axis);
    
    void setFunctionAxis(AxisFunction_t function, int axis);
    int getFunctionAxis(AxisFunction_t function);
    
    QStringList actions(void);
    QVariantList buttonActions(void);
    
    QString name(void) { return _name; }
    
    int throttleMode(void);
    void setThrottleMode(int mode);
    
Don Gagne's avatar
Don Gagne committed
92 93 94 95 96 97 98 99
    typedef enum {
        CalibrationModeOff,         // Not calibrating
        CalibrationModeMonitor,     // Monitors are active, continue to send to vehicle if already polling
        CalibrationModeCalibrating, // Calibrating, stop sending joystick to vehicle
    } CalibrationMode_t;
    
    /// Set the current calibration mode
    void startCalibrationMode(CalibrationMode_t mode);
100
    
Don Gagne's avatar
Don Gagne committed
101 102
    /// Clear the current calibration mode
    void stopCalibrationMode(CalibrationMode_t mode);
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
    
signals:
    void calibratedChanged(bool calibrated);
    
    // The raw signals are only meant for use by calibration
    void rawAxisValueChanged(int index, int value);
    void rawButtonPressedChanged(int index, int pressed);
    
    void buttonActionsChanged(QVariantList actions);
    
    void throttleModeChanged(int mode);
    
    void enabledChanged(bool enabled);
    
    /// Signal containing new joystick information
    ///     @param roll     Range is -1:1, negative meaning roll left, positive meaning roll right
    ///     @param pitch    Range i -1:1, negative meaning pitch down, positive meaning pitch up
    ///     @param yaw      Range is -1:1, negative meaning yaw left, positive meaning yaw right
    ///     @param throttle Range is 0:1, 0 meaning no throttle, 1 meaning full throttle
    ///     @param mode     See Vehicle::JoystickMode_t enum
    void manualControl(float roll, float pitch, float yaw, float throttle, quint16 buttons, int joystickMmode);
    
    void buttonActionTriggered(int action);
    
127
protected:
128 129 130
    void _saveSettings(void);
    void _loadSettings(void);
    float _adjustRange(int value, Calibration_t calibration);
Don Gagne's avatar
Don Gagne committed
131
    void _buttonAction(const QString& action);
132 133 134
    bool _validAxis(int axis);
    bool _validButton(int button);

135
private:
Gregory Dymarek's avatar
Gregory Dymarek committed
136 137 138
    virtual bool _open() = 0;
    virtual void _close() = 0;
    virtual bool _update() = 0;
139

Gregory Dymarek's avatar
Gregory Dymarek committed
140 141
    virtual bool _getButton(int i) = 0;
    virtual int _getAxis(int i) = 0;
142
    virtual uint8_t _getHat(int hat,int i) = 0;
143

144 145 146
    // Override from QThread
    virtual void run(void);

147
protected:
148 149 150 151 152 153 154
    
    bool    _exitThread;    ///< true: signal thread to exit
    
    QString _name;
    bool    _calibrated;
    int     _axisCount;
    int     _buttonCount;
155 156 157
    int     _hatCount;
    int     _hatButtonCount;
    int     _totalButtonCount;
158
    
Don Gagne's avatar
Don Gagne committed
159 160
    CalibrationMode_t   _calibrationMode;
    
161 162
    int*                _rgAxisValues;
    Calibration_t*      _rgCalibration;
163 164
    int                 _rgFunctionAxis[maxFunction];
    
165 166
    bool*               _rgButtonValues;
    QString*            _rgButtonActions;
167 168 169
    quint16             _lastButtonBits;
    
    ThrottleMode_t      _throttleMode;
170 171 172
    
    Vehicle*            _activeVehicle;
    bool                _pollingStartedForCalibration;
173 174

    MultiVehicleManager*    _multiVehicleManager;
175
    
176 177 178
private:
    static const char*  _rgFunctionSettingsKey[maxFunction];

179 180 181 182 183 184 185
    static const char* _settingsGroup;
    static const char* _calibratedSettingsKey;
    static const char* _buttonActionSettingsKey;
    static const char* _throttleModeSettingsKey;
};
    
#endif