Christopher Doel / Mbed 2 deprecated el17cd

Cube Dodger A 3D 'endless runner' game

Dependencies:   mbed

Gamepad/Gamepad.h@46:824ec81ff578, 2019-05-08 (annotated)

Committer:
el17cd
Date:
Wed May 08 18:17:59 2019 +0000
Revision:
46:824ec81ff578
Parent:
0:efb5eec6b8ea 
Potentiometer now changes screen contrast for use on other devices.; Final Submission.; I have read and agreed with the Statement of Academic Integrity.

Who changed what in which revision?

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