Library for ELEC2645 Gamepad PCB. University of Leeds Version 2 January 2020
Dependents: ELEC2645_Ticker_WAV ELEC2645_Project_username ELEC2645_Project_el18vgt ELEC2645_Project_el17oc11 ... more
Gamepad.h@20:c0959710291b, 2017-04-26 (annotated)
- Committer:
- valavanisalex
- Date:
- Wed Apr 26 13:58:10 2017 +0000
- Revision:
- 20:c0959710291b
- Parent:
- 19:c2bb79a10b3c
- Child:
- 21:da0b4e14c867
Correct spellings
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
eencae | 0:a6288c29b936 | 1 | #ifndef GAMEPAD_H |
eencae | 0:a6288c29b936 | 2 | #define GAMEPAD_H |
eencae | 0:a6288c29b936 | 3 | |
valavanisalex | 12:1b0b6355da4f | 4 | #include <bitset> |
valavanisalex | 12:1b0b6355da4f | 5 | |
valavanisalex | 13:ef5fc9f58805 | 6 | // Forward declaration of the classes that we use from the mbed library |
valavanisalex | 13:ef5fc9f58805 | 7 | // This avoids the need for us to include the huge mbed.h header inside our |
valavanisalex | 13:ef5fc9f58805 | 8 | // own library API |
valavanisalex | 13:ef5fc9f58805 | 9 | namespace mbed |
valavanisalex | 13:ef5fc9f58805 | 10 | { |
valavanisalex | 13:ef5fc9f58805 | 11 | class AnalogIn; |
valavanisalex | 13:ef5fc9f58805 | 12 | class InterruptIn; |
valavanisalex | 13:ef5fc9f58805 | 13 | class PwmOut; |
valavanisalex | 13:ef5fc9f58805 | 14 | class Timeout; |
valavanisalex | 13:ef5fc9f58805 | 15 | } |
eencae | 3:964a6d95acdd | 16 | |
eencae | 3:964a6d95acdd | 17 | #define TOL 0.1f |
eencae | 3:964a6d95acdd | 18 | #define RAD2DEG 57.2957795131f |
eencae | 3:964a6d95acdd | 19 | |
eencae | 9:893189072e89 | 20 | /** Enum for direction */ |
eencae | 3:964a6d95acdd | 21 | enum Direction { |
eencae | 9:893189072e89 | 22 | CENTRE, /**< joystick centred */ |
eencae | 9:893189072e89 | 23 | N, /**< pushed North (0)*/ |
eencae | 9:893189072e89 | 24 | NE, /**< pushed North-East (45) */ |
eencae | 9:893189072e89 | 25 | E, /**< pushed East (90) */ |
eencae | 9:893189072e89 | 26 | SE, /**< pushed South-East (135) */ |
eencae | 9:893189072e89 | 27 | S, /**< pushed South (180) */ |
eencae | 9:893189072e89 | 28 | SW, /**< pushed South-West (225) */ |
eencae | 9:893189072e89 | 29 | W, /**< pushed West (270) */ |
eencae | 9:893189072e89 | 30 | NW /**< pushed North-West (315) */ |
eencae | 3:964a6d95acdd | 31 | }; |
eencae | 3:964a6d95acdd | 32 | |
eencae | 9:893189072e89 | 33 | /** Vector 2D struct */ |
eencae | 3:964a6d95acdd | 34 | struct Vector2D { |
eencae | 9:893189072e89 | 35 | float x; /**< float for x value */ |
eencae | 9:893189072e89 | 36 | float y; /**< float for y value */ |
eencae | 3:964a6d95acdd | 37 | }; |
eencae | 3:964a6d95acdd | 38 | |
eencae | 9:893189072e89 | 39 | /** Polar coordinate struct */ |
eencae | 3:964a6d95acdd | 40 | struct Polar { |
eencae | 9:893189072e89 | 41 | float mag; /**< float for magnitude */ |
eencae | 9:893189072e89 | 42 | float angle; /**< float for angle (in degrees) */ |
eencae | 3:964a6d95acdd | 43 | }; |
eencae | 0:a6288c29b936 | 44 | |
eencae | 9:893189072e89 | 45 | /** Gamepad Class |
valavanisalex | 20:c0959710291b | 46 | * @brief Library for interfacing with ELEC2645 Gamepad PCB, University of Leeds |
valavanisalex | 20:c0959710291b | 47 | * @author Dr Craig A. Evans |
valavanisalex | 20:c0959710291b | 48 | * @author Dr Alex Valavanis |
valavanisalex | 20:c0959710291b | 49 | */ |
eencae | 0:a6288c29b936 | 50 | class Gamepad |
eencae | 0:a6288c29b936 | 51 | { |
valavanisalex | 19:c2bb79a10b3c | 52 | public: |
valavanisalex | 19:c2bb79a10b3c | 53 | /** Gamepad events |
valavanisalex | 16:3ea3d9714b0c | 54 | * @brief List of events that can be registered on the gamepad |
valavanisalex | 16:3ea3d9714b0c | 55 | */ |
valavanisalex | 16:3ea3d9714b0c | 56 | enum GamepadEvent { |
valavanisalex | 16:3ea3d9714b0c | 57 | A_PRESSED, ///< Button A has been pressed |
valavanisalex | 16:3ea3d9714b0c | 58 | B_PRESSED, ///< Button B has been pressed |
valavanisalex | 16:3ea3d9714b0c | 59 | X_PRESSED, ///< Button X has been pressed |
valavanisalex | 16:3ea3d9714b0c | 60 | Y_PRESSED, ///< Button Y has been pressed |
valavanisalex | 16:3ea3d9714b0c | 61 | L_PRESSED, ///< Button L has been pressed |
valavanisalex | 16:3ea3d9714b0c | 62 | R_PRESSED, ///< Button R has been pressed |
valavanisalex | 16:3ea3d9714b0c | 63 | BACK_PRESSED, ///< Button "Back" has been pressed |
valavanisalex | 16:3ea3d9714b0c | 64 | START_PRESSED, ///< Button "Start" has been pressed |
valavanisalex | 16:3ea3d9714b0c | 65 | JOY_PRESSED, ///< Joystick button has been pressed |
valavanisalex | 16:3ea3d9714b0c | 66 | N_EVENTS ///< A dummy flag that marks the end of the list |
valavanisalex | 16:3ea3d9714b0c | 67 | }; |
valavanisalex | 19:c2bb79a10b3c | 68 | |
valavanisalex | 11:ff86b2ffce01 | 69 | private: |
valavanisalex | 13:ef5fc9f58805 | 70 | mbed::PwmOut *_led1; |
valavanisalex | 13:ef5fc9f58805 | 71 | mbed::PwmOut *_led2; |
valavanisalex | 13:ef5fc9f58805 | 72 | mbed::PwmOut *_led3; |
valavanisalex | 13:ef5fc9f58805 | 73 | mbed::PwmOut *_led4; |
valavanisalex | 13:ef5fc9f58805 | 74 | mbed::PwmOut *_led5; |
valavanisalex | 13:ef5fc9f58805 | 75 | mbed::PwmOut *_led6; |
valavanisalex | 11:ff86b2ffce01 | 76 | |
valavanisalex | 13:ef5fc9f58805 | 77 | mbed::InterruptIn *_button_A; |
valavanisalex | 13:ef5fc9f58805 | 78 | mbed::InterruptIn *_button_B; |
valavanisalex | 13:ef5fc9f58805 | 79 | mbed::InterruptIn *_button_X; |
valavanisalex | 13:ef5fc9f58805 | 80 | mbed::InterruptIn *_button_Y; |
valavanisalex | 13:ef5fc9f58805 | 81 | mbed::InterruptIn *_button_L; |
valavanisalex | 13:ef5fc9f58805 | 82 | mbed::InterruptIn *_button_R; |
valavanisalex | 13:ef5fc9f58805 | 83 | mbed::InterruptIn *_button_back; |
valavanisalex | 13:ef5fc9f58805 | 84 | mbed::InterruptIn *_button_start; |
valavanisalex | 13:ef5fc9f58805 | 85 | mbed::InterruptIn *_button_joystick; |
valavanisalex | 11:ff86b2ffce01 | 86 | |
valavanisalex | 13:ef5fc9f58805 | 87 | mbed::AnalogIn *_vert; |
valavanisalex | 13:ef5fc9f58805 | 88 | mbed::AnalogIn *_horiz; |
valavanisalex | 11:ff86b2ffce01 | 89 | |
valavanisalex | 13:ef5fc9f58805 | 90 | mbed::PwmOut *_buzzer; |
valavanisalex | 13:ef5fc9f58805 | 91 | mbed::AnalogIn *_pot; |
valavanisalex | 11:ff86b2ffce01 | 92 | |
valavanisalex | 13:ef5fc9f58805 | 93 | mbed::Timeout *_timeout; |
valavanisalex | 11:ff86b2ffce01 | 94 | |
valavanisalex | 12:1b0b6355da4f | 95 | std::bitset<N_EVENTS> _event_state; ///< A binary list of buttons that has been pressed |
valavanisalex | 11:ff86b2ffce01 | 96 | |
valavanisalex | 11:ff86b2ffce01 | 97 | // centred x,y values |
valavanisalex | 11:ff86b2ffce01 | 98 | float _x0; |
valavanisalex | 11:ff86b2ffce01 | 99 | float _y0; |
eencae | 0:a6288c29b936 | 100 | |
eencae | 0:a6288c29b936 | 101 | public: |
eencae | 9:893189072e89 | 102 | /** Constructor */ |
eencae | 0:a6288c29b936 | 103 | Gamepad(); |
eencae | 8:7eaf26f4b5f2 | 104 | |
eencae | 9:893189072e89 | 105 | /** Destructor */ |
eencae | 1:6d25cd49059b | 106 | ~Gamepad(); |
eencae | 0:a6288c29b936 | 107 | |
eencae | 9:893189072e89 | 108 | /** Initialise all peripherals and configure interrupts */ |
eencae | 0:a6288c29b936 | 109 | void init(); |
eencae | 8:7eaf26f4b5f2 | 110 | |
eencae | 9:893189072e89 | 111 | /** Turn all LEDs on */ |
eencae | 0:a6288c29b936 | 112 | void leds_on(); |
eencae | 8:7eaf26f4b5f2 | 113 | |
eencae | 9:893189072e89 | 114 | /** Turn all LEDs off */ |
eencae | 0:a6288c29b936 | 115 | void leds_off(); |
eencae | 8:7eaf26f4b5f2 | 116 | |
eencae | 9:893189072e89 | 117 | /** Set all LEDs to duty-cycle |
eencae | 9:893189072e89 | 118 | *@param value in range 0.0 to 1.0 |
eencae | 9:893189072e89 | 119 | */ |
valavanisalex | 11:ff86b2ffce01 | 120 | void leds(float val) const; |
eencae | 9:893189072e89 | 121 | |
eencae | 9:893189072e89 | 122 | /** Set LED to duty-cycle |
eencae | 17:cf1e1ffcf773 | 123 | *@param led number (0 to 5) |
eencae | 9:893189072e89 | 124 | *@param value in range 0.0 to 1.0 |
eencae | 9:893189072e89 | 125 | */ |
eencae | 18:e0a4f15a7750 | 126 | void led(int n,float val) const; |
eencae | 1:6d25cd49059b | 127 | |
eencae | 8:7eaf26f4b5f2 | 128 | /** Read potentiometer |
eencae | 9:893189072e89 | 129 | *@returns potentiometer value in range 0.0 to 1.0 |
eencae | 8:7eaf26f4b5f2 | 130 | */ |
valavanisalex | 11:ff86b2ffce01 | 131 | float read_pot() const; |
eencae | 8:7eaf26f4b5f2 | 132 | |
eencae | 8:7eaf26f4b5f2 | 133 | /** Play tone on piezo |
eencae | 9:893189072e89 | 134 | * @param frequency in Hz |
eencae | 9:893189072e89 | 135 | * @param duration of tone in seconds |
eencae | 8:7eaf26f4b5f2 | 136 | */ |
eencae | 1:6d25cd49059b | 137 | void tone(float frequency, float duration); |
eencae | 1:6d25cd49059b | 138 | |
valavanisalex | 12:1b0b6355da4f | 139 | /** |
valavanisalex | 12:1b0b6355da4f | 140 | * @brief Check whether an event flag has been set and clear it |
valavanisalex | 12:1b0b6355da4f | 141 | * @param id[in] The ID of the event to test |
valavanisalex | 12:1b0b6355da4f | 142 | * @return true if the event occurred |
valavanisalex | 12:1b0b6355da4f | 143 | */ |
valavanisalex | 12:1b0b6355da4f | 144 | bool check_event(GamepadEvent const id); |
valavanisalex | 13:ef5fc9f58805 | 145 | |
valavanisalex | 19:c2bb79a10b3c | 146 | /** |
valavanisalex | 19:c2bb79a10b3c | 147 | * @brief Get the raw binary event state |
valavanisalex | 19:c2bb79a10b3c | 148 | * @return The event state as a binary code |
valavanisalex | 19:c2bb79a10b3c | 149 | * @details The check_event() function is likely to be more useful than |
valavanisalex | 19:c2bb79a10b3c | 150 | * this, for testing whether a given event has occurred. It can be |
valavanisalex | 19:c2bb79a10b3c | 151 | * useful for debugging via the terminal, however, for example: |
valavanisalex | 19:c2bb79a10b3c | 152 | * @code |
valavanisalex | 19:c2bb79a10b3c | 153 | * std::cout << gamepad.get_raw_event_state() << std::endl; |
valavanisalex | 19:c2bb79a10b3c | 154 | * @endcode |
valavanisalex | 19:c2bb79a10b3c | 155 | */ |
valavanisalex | 19:c2bb79a10b3c | 156 | inline std::bitset<N_EVENTS> get_raw_event_state() const { |
valavanisalex | 19:c2bb79a10b3c | 157 | return _event_state; |
valavanisalex | 19:c2bb79a10b3c | 158 | } |
valavanisalex | 19:c2bb79a10b3c | 159 | |
eencae | 8:7eaf26f4b5f2 | 160 | /** Get magnitude of joystick movement |
eencae | 9:893189072e89 | 161 | * @returns value in range 0.0 to 1.0 |
eencae | 8:7eaf26f4b5f2 | 162 | */ |
eencae | 8:7eaf26f4b5f2 | 163 | float get_mag(); |
eencae | 9:893189072e89 | 164 | |
eencae | 8:7eaf26f4b5f2 | 165 | /** Get angle of joystick movement |
eencae | 9:893189072e89 | 166 | * @returns value in range 0.0 to 359.9. 0.0 corresponds to N, 180.0 to S. -1.0 is central |
eencae | 8:7eaf26f4b5f2 | 167 | */ |
eencae | 3:964a6d95acdd | 168 | float get_angle(); |
eencae | 9:893189072e89 | 169 | |
eencae | 8:7eaf26f4b5f2 | 170 | /** Gets joystick direction |
eencae | 9:893189072e89 | 171 | * @returns an enum: CENTRE, N, NE, E, SE, S, SW, W, NW, |
eencae | 8:7eaf26f4b5f2 | 172 | */ |
eencae | 3:964a6d95acdd | 173 | Direction get_direction(); // N,NE,E,SE etc. |
eencae | 9:893189072e89 | 174 | |
eencae | 8:7eaf26f4b5f2 | 175 | /** Gets raw cartesian co-ordinates of joystick |
eencae | 9:893189072e89 | 176 | * @returns a struct with x,y members, each in the range 0.0 to 1.0 |
eencae | 8:7eaf26f4b5f2 | 177 | */ |
eencae | 5:ce5eae9ee934 | 178 | Vector2D get_coord(); // cartesian co-ordinates x,y |
eencae | 9:893189072e89 | 179 | |
eencae | 8:7eaf26f4b5f2 | 180 | /** Gets cartesian coordinates mapped to circular grid |
eencae | 9:893189072e89 | 181 | * @returns a struct with x,y members, each in the range 0.0 to 1.0 |
eencae | 8:7eaf26f4b5f2 | 182 | */ |
eencae | 5:ce5eae9ee934 | 183 | Vector2D get_mapped_coord(); // x,y mapped to circle |
eencae | 9:893189072e89 | 184 | |
eencae | 8:7eaf26f4b5f2 | 185 | /** Gets polar coordinates of the joystick |
eencae | 9:893189072e89 | 186 | * @returns a struct contains mag and angle |
eencae | 8:7eaf26f4b5f2 | 187 | */ |
eencae | 5:ce5eae9ee934 | 188 | Polar get_polar(); // mag and angle in struct form |
eencae | 3:964a6d95acdd | 189 | |
eencae | 0:a6288c29b936 | 190 | private: |
eencae | 1:6d25cd49059b | 191 | void init_buttons(); |
eencae | 1:6d25cd49059b | 192 | void tone_off(); |
eencae | 3:964a6d95acdd | 193 | |
eencae | 1:6d25cd49059b | 194 | void a_isr(); |
eencae | 1:6d25cd49059b | 195 | void b_isr(); |
eencae | 1:6d25cd49059b | 196 | void x_isr(); |
eencae | 1:6d25cd49059b | 197 | void y_isr(); |
eencae | 1:6d25cd49059b | 198 | void l_isr(); |
eencae | 1:6d25cd49059b | 199 | void r_isr(); |
eencae | 1:6d25cd49059b | 200 | void back_isr(); |
eencae | 1:6d25cd49059b | 201 | void start_isr(); |
eencae | 3:964a6d95acdd | 202 | void joy_isr(); |
eencae | 0:a6288c29b936 | 203 | }; |
eencae | 0:a6288c29b936 | 204 | |
eencae | 0:a6288c29b936 | 205 | #endif |