Joystick.h 7.38 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

class Joystick : public QThread
{
    Q_OBJECT
27

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

31
    ~Joystick();
32

33
    typedef struct Calibration_t {
34 35 36
        int     min;
        int     max;
        int     center;
37
        int     deadband;
38
        bool    reversed;
39 40 41 42 43 44
        Calibration_t()
            : min(-32767)
            , max(32767)
            , center(0)
            , deadband(0)
            , reversed(false) {}
45
    } Calibration_t;
46

47 48 49 50 51 52 53
    typedef enum {
        rollFunction,
        pitchFunction,
        yawFunction,
        throttleFunction,
        maxFunction
    } AxisFunction_t;
54

55 56 57 58 59
    typedef enum {
        ThrottleModeCenterZero,
        ThrottleModeDownZero,
        ThrottleModeMax
    } ThrottleMode_t;
60

61
    Q_PROPERTY(QString name READ name CONSTANT)
62

Don Gagne's avatar
Don Gagne committed
63
    Q_PROPERTY(bool calibrated MEMBER _calibrated NOTIFY calibratedChanged)
64

65
    Q_PROPERTY(int totalButtonCount  READ totalButtonCount    CONSTANT)
66
    Q_PROPERTY(int axisCount    READ axisCount      CONSTANT)
67

68
    Q_PROPERTY(QStringList actions READ actions CONSTANT)
69

70
    Q_PROPERTY(QVariantList buttonActions READ buttonActions NOTIFY buttonActionsChanged)
Don Gagne's avatar
Don Gagne committed
71 72
    Q_INVOKABLE void setButtonAction(int button, const QString& action);
    Q_INVOKABLE QString getButtonAction(int button);
73

74
    Q_PROPERTY(int throttleMode READ throttleMode WRITE setThrottleMode NOTIFY throttleModeChanged)
75
    Q_PROPERTY(float exponential READ exponential WRITE setExponential NOTIFY exponentialChanged)
76
    Q_PROPERTY(bool accumulator READ accumulator WRITE setAccumulator NOTIFY accumulatorChanged)
77 78
	Q_PROPERTY(bool requiresCalibration READ requiresCalibration CONSTANT)
    
79 80 81
    // Property accessors

    int axisCount(void) { return _axisCount; }
82
    int totalButtonCount(void) { return _totalButtonCount; }
83

84
    /// Start the polling thread which will in turn emit joystick signals
85
    void startPolling(Vehicle* vehicle);
86
    void stopPolling(void);
87

88 89
    void setCalibration(int axis, Calibration_t& calibration);
    Calibration_t getCalibration(int axis);
90

91 92
    void setFunctionAxis(AxisFunction_t function, int axis);
    int getFunctionAxis(AxisFunction_t function);
93

94 95
    QStringList actions(void);
    QVariantList buttonActions(void);
96

97
    QString name(void) { return _name; }
98
/*
Jacob Walser's avatar
Jacob Walser committed
99
    // Joystick index used by sdl library
Patrick José Pereira's avatar
Patrick José Pereira committed
100
    // Settable because sdl library remaps indices after certain events
Jacob Walser's avatar
Jacob Walser committed
101 102
    virtual int index(void) = 0;
    virtual void setIndex(int index) = 0;
103
*/
104 105
	virtual bool requiresCalibration(void) { return true; }

106 107
    int throttleMode(void);
    void setThrottleMode(int mode);
108

109 110
    float exponential(void);
    void setExponential(float expo);
111

112 113 114
    bool accumulator(void);
    void setAccumulator(bool accu);

Gregory Dymarek's avatar
Gregory Dymarek committed
115 116 117
    bool deadband(void);
    void setDeadband(bool accu);

118 119 120
    void setTXMode(int mode);
    int getTXMode(void) { return _transmitterMode; }

Don Gagne's avatar
Don Gagne committed
121 122 123 124 125
    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;
126

Don Gagne's avatar
Don Gagne committed
127 128
    /// Set the current calibration mode
    void startCalibrationMode(CalibrationMode_t mode);
129

Don Gagne's avatar
Don Gagne committed
130 131
    /// Clear the current calibration mode
    void stopCalibrationMode(CalibrationMode_t mode);
132

133 134
signals:
    void calibratedChanged(bool calibrated);
135

136 137 138
    // The raw signals are only meant for use by calibration
    void rawAxisValueChanged(int index, int value);
    void rawButtonPressedChanged(int index, int pressed);
139

140
    void buttonActionsChanged(QVariantList actions);
141

142
    void throttleModeChanged(int mode);
143

144
    void exponentialChanged(float exponential);
145

146 147
    void accumulatorChanged(bool accumulator);

148
    void enabledChanged(bool enabled);
149

150 151 152 153 154 155 156
    /// 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);
157

158
    void buttonActionTriggered(int action);
159

160
protected:
161 162 163 164 165 166 167
    void    _setDefaultCalibration(void);
    void    _saveSettings(void);
    void    _loadSettings(void);
    float   _adjustRange(int value, Calibration_t calibration, bool withDeadbands);
    void    _buttonAction(const QString& action);
    bool    _validAxis(int axis);
    bool    _validButton(int button);
168

169
private:
Gregory Dymarek's avatar
Gregory Dymarek committed
170 171 172
    virtual bool _open() = 0;
    virtual void _close() = 0;
    virtual bool _update() = 0;
173

Gregory Dymarek's avatar
Gregory Dymarek committed
174 175
    virtual bool _getButton(int i) = 0;
    virtual int _getAxis(int i) = 0;
176
    virtual uint8_t _getHat(int hat,int i) = 0;
177

178 179 180
    int _mapFunctionMode(int mode, int function);
    void _remapAxes(int currentMode, int newMode, int (&newMapping)[maxFunction]);

181 182 183
    // Override from QThread
    virtual void run(void);

184
protected:
185

186
    bool    _exitThread;    ///< true: signal thread to exit
187

188 189 190 191
    QString _name;
    bool    _calibrated;
    int     _axisCount;
    int     _buttonCount;
192 193 194
    int     _hatCount;
    int     _hatButtonCount;
    int     _totalButtonCount;
195

196
    static int          _transmitterMode;
Don Gagne's avatar
Don Gagne committed
197
    CalibrationMode_t   _calibrationMode;
198

199 200
    int*                _rgAxisValues;
    Calibration_t*      _rgCalibration;
201
    int                 _rgFunctionAxis[maxFunction];
202

203
    bool*               _rgButtonValues;
204
    QStringList         _rgButtonActions;
205
    quint16             _lastButtonBits;
206

207
    ThrottleMode_t      _throttleMode;
208

209
    float                _exponential;
210
    bool                _accumulator;
Gregory Dymarek's avatar
Gregory Dymarek committed
211
    bool                _deadband;
212

213 214
    Vehicle*            _activeVehicle;
    bool                _pollingStartedForCalibration;
215 216

    MultiVehicleManager*    _multiVehicleManager;
217

218 219 220
private:
    static const char*  _rgFunctionSettingsKey[maxFunction];

221 222 223 224
    static const char* _settingsGroup;
    static const char* _calibratedSettingsKey;
    static const char* _buttonActionSettingsKey;
    static const char* _throttleModeSettingsKey;
225
    static const char* _exponentialSettingsKey;
226
    static const char* _accumulatorSettingsKey;
Gregory Dymarek's avatar
Gregory Dymarek committed
227
    static const char* _deadbandSettingsKey;
228
    static const char* _txModeSettingsKey;
229 230 231 232 233 234 235 236
    static const char* _fixedWingTXModeSettingsKey;
    static const char* _multiRotorTXModeSettingsKey;
    static const char* _roverTXModeSettingsKey;
    static const char* _vtolTXModeSettingsKey;
    static const char* _submarineTXModeSettingsKey;

private slots:
    void _activeVehicleChanged(Vehicle* activeVehicle);
237
};
238

239
#endif