Max Houghton / Gamepad

Class used to interface with the handheld gamepad.

Fork of Gamepad by Craig Evans

Gamepad.h@19:c2bb79a10b3c, 2017-04-25 (annotated)

Committer:
valavanisalex
Date:
Tue Apr 25 10:19:47 2017 +0000
Revision:
19:c2bb79a10b3c
Parent:
18:e0a4f15a7750
Child:
20:c0959710291b
Add get_raw_event_state() method for debugging

Who changed what in which revision?

UserRevisionLine numberNew 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
eencae 9:893189072e89 46 @brief Library for interfacing with ELEC2645 Gamepad PCB, University of Leeds
eencae 9:893189072e89 47 @author Dr Craig A. Evans
eencae 17:cf1e1ffcf773 48 @author Dr Alex Valanvanis
eencae 9:893189072e89 49 @date Febraury 2017
eencae 9:893189072e89 50 */
eencae 0:a6288c29b936 51 class Gamepad
eencae 0:a6288c29b936 52 {
valavanisalex 19:c2bb79a10b3c 53 public:
valavanisalex 19:c2bb79a10b3c 54 /** Gamepad events
valavanisalex 16:3ea3d9714b0c 55 * @brief List of events that can be registered on the gamepad
valavanisalex 16:3ea3d9714b0c 56 */
valavanisalex 16:3ea3d9714b0c 57 enum GamepadEvent {
valavanisalex 16:3ea3d9714b0c 58 A_PRESSED, ///< Button A has been pressed
valavanisalex 16:3ea3d9714b0c 59 B_PRESSED, ///< Button B has been pressed
valavanisalex 16:3ea3d9714b0c 60 X_PRESSED, ///< Button X has been pressed
valavanisalex 16:3ea3d9714b0c 61 Y_PRESSED, ///< Button Y has been pressed
valavanisalex 16:3ea3d9714b0c 62 L_PRESSED, ///< Button L has been pressed
valavanisalex 16:3ea3d9714b0c 63 R_PRESSED, ///< Button R has been pressed
valavanisalex 16:3ea3d9714b0c 64 BACK_PRESSED, ///< Button "Back" has been pressed
valavanisalex 16:3ea3d9714b0c 65 START_PRESSED, ///< Button "Start" has been pressed
valavanisalex 16:3ea3d9714b0c 66 JOY_PRESSED, ///< Joystick button has been pressed
valavanisalex 16:3ea3d9714b0c 67 N_EVENTS ///< A dummy flag that marks the end of the list
valavanisalex 16:3ea3d9714b0c 68 };
valavanisalex 19:c2bb79a10b3c 69
valavanisalex 11:ff86b2ffce01 70 private:
valavanisalex 13:ef5fc9f58805 71 mbed::PwmOut *_led1;
valavanisalex 13:ef5fc9f58805 72 mbed::PwmOut *_led2;
valavanisalex 13:ef5fc9f58805 73 mbed::PwmOut *_led3;
valavanisalex 13:ef5fc9f58805 74 mbed::PwmOut *_led4;
valavanisalex 13:ef5fc9f58805 75 mbed::PwmOut *_led5;
valavanisalex 13:ef5fc9f58805 76 mbed::PwmOut *_led6;
valavanisalex 11:ff86b2ffce01 77
valavanisalex 13:ef5fc9f58805 78 mbed::InterruptIn *_button_A;
valavanisalex 13:ef5fc9f58805 79 mbed::InterruptIn *_button_B;
valavanisalex 13:ef5fc9f58805 80 mbed::InterruptIn *_button_X;
valavanisalex 13:ef5fc9f58805 81 mbed::InterruptIn *_button_Y;
valavanisalex 13:ef5fc9f58805 82 mbed::InterruptIn *_button_L;
valavanisalex 13:ef5fc9f58805 83 mbed::InterruptIn *_button_R;
valavanisalex 13:ef5fc9f58805 84 mbed::InterruptIn *_button_back;
valavanisalex 13:ef5fc9f58805 85 mbed::InterruptIn *_button_start;
valavanisalex 13:ef5fc9f58805 86 mbed::InterruptIn *_button_joystick;
valavanisalex 11:ff86b2ffce01 87
valavanisalex 13:ef5fc9f58805 88 mbed::AnalogIn *_vert;
valavanisalex 13:ef5fc9f58805 89 mbed::AnalogIn *_horiz;
valavanisalex 11:ff86b2ffce01 90
valavanisalex 13:ef5fc9f58805 91 mbed::PwmOut *_buzzer;
valavanisalex 13:ef5fc9f58805 92 mbed::AnalogIn *_pot;
valavanisalex 11:ff86b2ffce01 93
valavanisalex 13:ef5fc9f58805 94 mbed::Timeout *_timeout;
valavanisalex 11:ff86b2ffce01 95
valavanisalex 12:1b0b6355da4f 96 std::bitset<N_EVENTS> _event_state; ///< A binary list of buttons that has been pressed
valavanisalex 11:ff86b2ffce01 97
valavanisalex 11:ff86b2ffce01 98 // centred x,y values
valavanisalex 11:ff86b2ffce01 99 float _x0;
valavanisalex 11:ff86b2ffce01 100 float _y0;
eencae 0:a6288c29b936 101
eencae 0:a6288c29b936 102 public:
eencae 9:893189072e89 103 /** Constructor */
eencae 0:a6288c29b936 104 Gamepad();
eencae 8:7eaf26f4b5f2 105
eencae 9:893189072e89 106 /** Destructor */
eencae 1:6d25cd49059b 107 ~Gamepad();
eencae 0:a6288c29b936 108
eencae 9:893189072e89 109 /** Initialise all peripherals and configure interrupts */
eencae 0:a6288c29b936 110 void init();
eencae 8:7eaf26f4b5f2 111
eencae 9:893189072e89 112 /** Turn all LEDs on */
eencae 0:a6288c29b936 113 void leds_on();
eencae 8:7eaf26f4b5f2 114
eencae 9:893189072e89 115 /** Turn all LEDs off */
eencae 0:a6288c29b936 116 void leds_off();
eencae 8:7eaf26f4b5f2 117
eencae 9:893189072e89 118 /** Set all LEDs to duty-cycle
eencae 9:893189072e89 119 *@param value in range 0.0 to 1.0
eencae 9:893189072e89 120 */
valavanisalex 11:ff86b2ffce01 121 void leds(float val) const;
eencae 9:893189072e89 122
eencae 9:893189072e89 123 /** Set LED to duty-cycle
eencae 17:cf1e1ffcf773 124 *@param led number (0 to 5)
eencae 9:893189072e89 125 *@param value in range 0.0 to 1.0
eencae 9:893189072e89 126 */
eencae 18:e0a4f15a7750 127 void led(int n,float val) const;
eencae 1:6d25cd49059b 128
eencae 8:7eaf26f4b5f2 129 /** Read potentiometer
eencae 9:893189072e89 130 *@returns potentiometer value in range 0.0 to 1.0
eencae 8:7eaf26f4b5f2 131 */
valavanisalex 11:ff86b2ffce01 132 float read_pot() const;
eencae 8:7eaf26f4b5f2 133
eencae 8:7eaf26f4b5f2 134 /** Play tone on piezo
eencae 9:893189072e89 135 * @param frequency in Hz
eencae 9:893189072e89 136 * @param duration of tone in seconds
eencae 8:7eaf26f4b5f2 137 */
eencae 1:6d25cd49059b 138 void tone(float frequency, float duration);
eencae 1:6d25cd49059b 139
valavanisalex 12:1b0b6355da4f 140 /**
valavanisalex 12:1b0b6355da4f 141 * @brief Check whether an event flag has been set and clear it
valavanisalex 12:1b0b6355da4f 142 * @param id[in] The ID of the event to test
valavanisalex 12:1b0b6355da4f 143 * @return true if the event occurred
valavanisalex 12:1b0b6355da4f 144 */
valavanisalex 12:1b0b6355da4f 145 bool check_event(GamepadEvent const id);
valavanisalex 13:ef5fc9f58805 146
valavanisalex 19:c2bb79a10b3c 147 /**
valavanisalex 19:c2bb79a10b3c 148 * @brief Get the raw binary event state
valavanisalex 19:c2bb79a10b3c 149 * @return The event state as a binary code
valavanisalex 19:c2bb79a10b3c 150 * @details The check_event() function is likely to be more useful than
valavanisalex 19:c2bb79a10b3c 151 * this, for testing whether a given event has occurred. It can be
valavanisalex 19:c2bb79a10b3c 152 * useful for debugging via the terminal, however, for example:
valavanisalex 19:c2bb79a10b3c 153 * @code
valavanisalex 19:c2bb79a10b3c 154 * std::cout << gamepad.get_raw_event_state() << std::endl;
valavanisalex 19:c2bb79a10b3c 155 * @endcode
valavanisalex 19:c2bb79a10b3c 156 */
valavanisalex 19:c2bb79a10b3c 157 inline std::bitset<N_EVENTS> get_raw_event_state() const {
valavanisalex 19:c2bb79a10b3c 158 return _event_state;
valavanisalex 19:c2bb79a10b3c 159 }
valavanisalex 19:c2bb79a10b3c 160
eencae 8:7eaf26f4b5f2 161 /** Get magnitude of joystick movement
eencae 9:893189072e89 162 * @returns value in range 0.0 to 1.0
eencae 8:7eaf26f4b5f2 163 */
eencae 8:7eaf26f4b5f2 164 float get_mag();
eencae 9:893189072e89 165
eencae 8:7eaf26f4b5f2 166 /** Get angle of joystick movement
eencae 9:893189072e89 167 * @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 168 */
eencae 3:964a6d95acdd 169 float get_angle();
eencae 9:893189072e89 170
eencae 8:7eaf26f4b5f2 171 /** Gets joystick direction
eencae 9:893189072e89 172 * @returns an enum: CENTRE, N, NE, E, SE, S, SW, W, NW,
eencae 8:7eaf26f4b5f2 173 */
eencae 3:964a6d95acdd 174 Direction get_direction(); // N,NE,E,SE etc.
eencae 9:893189072e89 175
eencae 8:7eaf26f4b5f2 176 /** Gets raw cartesian co-ordinates of joystick
eencae 9:893189072e89 177 * @returns a struct with x,y members, each in the range 0.0 to 1.0
eencae 8:7eaf26f4b5f2 178 */
eencae 5:ce5eae9ee934 179 Vector2D get_coord(); // cartesian co-ordinates x,y
eencae 9:893189072e89 180
eencae 8:7eaf26f4b5f2 181 /** Gets cartesian coordinates mapped to circular grid
eencae 9:893189072e89 182 * @returns a struct with x,y members, each in the range 0.0 to 1.0
eencae 8:7eaf26f4b5f2 183 */
eencae 5:ce5eae9ee934 184 Vector2D get_mapped_coord(); // x,y mapped to circle
eencae 9:893189072e89 185
eencae 8:7eaf26f4b5f2 186 /** Gets polar coordinates of the joystick
eencae 9:893189072e89 187 * @returns a struct contains mag and angle
eencae 8:7eaf26f4b5f2 188 */
eencae 5:ce5eae9ee934 189 Polar get_polar(); // mag and angle in struct form
eencae 3:964a6d95acdd 190
eencae 0:a6288c29b936 191 private:
eencae 1:6d25cd49059b 192 void init_buttons();
eencae 1:6d25cd49059b 193 void tone_off();
eencae 3:964a6d95acdd 194
eencae 1:6d25cd49059b 195 void a_isr();
eencae 1:6d25cd49059b 196 void b_isr();
eencae 1:6d25cd49059b 197 void x_isr();
eencae 1:6d25cd49059b 198 void y_isr();
eencae 1:6d25cd49059b 199 void l_isr();
eencae 1:6d25cd49059b 200 void r_isr();
eencae 1:6d25cd49059b 201 void back_isr();
eencae 1:6d25cd49059b 202 void start_isr();
eencae 3:964a6d95acdd 203 void joy_isr();
eencae 0:a6288c29b936 204 };
eencae 0:a6288c29b936 205
eencae 0:a6288c29b936 206 #endif